IDiscFormat2Erase::EraseMedia method (imapi2.h)
Erases the media in the active disc recorder.
Syntax
HRESULT EraseMedia();
Return value
S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:
| Return code | Description |
|---|---|
|
Pointer is not valid.
Value: 0x80004003 |
|
Unspecified failure.
Value: 0x80004005 |
|
Failed to allocate the required memory.
Value: 0x8007000E |
|
The device failed to accept the command within the timeout period. This may be caused by the device having entered an inconsistent state, or the timeout value for the command may need to be increased.
Value: 0xC0AA020D |
|
The device reported unexpected or invalid data for a command.
Value: 0xC0AA02FF |
|
The media is inserted upside down.
Value: 0xC0AA0204 |
|
The drive reported that it is in the process of becoming ready. Please try the request again later.
Value: 0xC0AA0205 |
|
There is no media in the device.
Value: 0xC0AA0202 |
|
The media is currently being formatted. Please wait for the format to complete before attempting to use the media.
Value: 0xC0AA0206 |
|
The drive reported that it is performing a long-running operation, such as finishing a write. The drive may be unusable for a long period of time.
Value: 0xC0AA0207 |
|
The write failed because the drive did not receive data quickly enough to continue writing. Moving the source data to the local computer, reducing the write speed, or enabling a "buffer underrun free" setting may resolve this issue.
Value: 0xC0AA0300 |
|
The media is not compatible or of unknown physical format.
Value: 0xC0AA0203 |
|
The DVD structure is not present. This may be caused by incompatible drive/medium used.
Value: 0xC0AA020E |
|
The device reported that the requested mode page (and type) is not present.
Value: 0xC0AA0201 |
|
The drive reported that the combination of parameters provided in the mode page for a MODE SELECT command were not supported.
Value: 0xC0AA0208 |
|
The drive reported that the media is write protected.
Value: 0xC0AA0209 |
|
The media's speed is incompatible with the device. This may be caused by using higher or lower speed media than the range of speeds supported by the device.
Value: 0xC0AA020F |
|
The specified handle is invalid.
Value: 6 |
|
The specified network resource or device is no longer available.
Value: 55 |
|
The device associated with this recorder during the last operation has been exclusively locked, causing this operation to failed.
Value: 0xC0AA0210 |
|
The current media type is unsupported.
Value: 0xC0AA0909 |
|
The drive returned an error for a START UNIT (spinup) command. Manual intervention may be required.
Value: 0x80AA0908 |
|
The drive did not complete the erase in one hour. The drive may require a power cycle, media removal, or other manual intervention to resume proper operation.
Note Currently, this value will also be returned if an attempt to perform an erase on CD-RW or DVD-RW media via the IDiscFormat2Erase interface fails as a result of the media being bad.
|
Remarks
Synchronously erases the media. Progress can be reported by calling into registered events of type DDiscFormat2EraseEvents.
Before calling this method, you must call the following methods:
You should also consider calling the IDiscFormat2Erase::put_FullErase method if its default value is not appropriate for your application.This method is synchronous. To determine the progress of the erase operation, you must implement the DDiscFormat2EraseEvents interface. For examples that show how to implement an event handler in a script, see Monitoring Progress With Events.
Currently, the E_IMAPI_ERASE_TOOK_LONGER_THAN_ONE_HOUR value is returned if an attempt to perform an erase on CD-RW or DVD-RW media via the IDiscFormat2Erase interface fails as a result of the media being bad or a drive failure.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista, Windows XP with SP2 [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | imapi2.h |