EraseTape
The EraseTape
function erases all or part of a tape.
DWORD EraseTape(
|
HANDLE hDevice, |
// handle to open
device |
|
DWORD dwEraseType, |
// type of erasure
to perform |
|
BOOL bImmediate |
// return after
erase operation begins |
|
); |
|
Parameters
hDevice
Identifies
the device where the tape is to be erased. This handle is created by using the CreateFile function.
dwEraseType
Specifies the
erasing technique. This parameter can be one of the following values:
|
Value |
Description |
|
TAPE_ERASE_LONG |
Erases the
tape from the current position to the end of the current partition. |
|
TAPE_ERASE_SHORT |
Writes an
erase gap or end-of-data marker at the current position. |
bImmediate
Specifies
whether to return as soon as the erase operation begins. If this parameter is
TRUE, the function returns immediately; if it is FALSE, the function does not
return until the erase operation has been completed.
Return Values
If the
function succeeds, the return value is NO_ERROR.
If the
function fails, the return value is one of the following error codes:
|
Error
code |
Description |
|
ERROR_BEGINNING_OF_MEDIA |
An attempt
to access data before the beginning-of-medium marker failed. |
|
ERROR_BUS_RESET |
A reset
condition was detected on the bus. |
|
ERROR_END_OF_MEDIA |
The
end-of-tape marker was reached during an operation. |
|
ERROR_FILEMARK_DETECTED |
A filemark
was reached during an operation. |
|
ERROR_SETMARK_DETECTED |
A setmark
was reached during an operation. |
|
ERROR_NO_DATA_DETECTED |
The
end-of-data marker was reached during an operation. |
|
ERROR_PARTITION_FAILURE |
The tape
could not be partitioned. |
|
ERROR_INVALID_BLOCK_LENGTH |
The block
size is incorrect on a new tape in a multivolume partition. |
|
ERROR_DEVICE_NOT_PARTITIONED |
The
partition information could not be found when a tape was being loaded. |
|
ERROR_MEDIA_CHANGED |
The tape
that was in the drive has been replaced or removed. |
|
ERROR_NO_MEDIA_IN_DRIVE |
There is no
media in the drive. |
|
ERROR_NOT_SUPPORTED |
The tape
driver does not support a requested function. |
|
ERROR_UNABLE_TO_LOCK_MEDIA |
An attempt
to lock the ejection mechanism failed. |
|
ERROR_UNABLE_TO_UNLOAD_MEDIA |
An attempt
to unload the tape failed. |
|
ERROR_WRITE_PROTECT |
The media
is write protected. |
Remarks
Some tape
devices do not support certain tape operations. To determine your tape device s capabilities, see your tape device documentation and
use the GetTapeParameters function.
See Also