Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The EraseTape function erases all or part of a tape.
Syntax
DWORD EraseTape(
[in] HANDLE hDevice,
[in] DWORD dwEraseType,
[in] BOOL bImmediate
);
Parameters
[in] hDevice
Handle to the device where the tape is to be erased. This handle is created by using the CreateFile function.
[in] dwEraseType
Erasing technique. This parameter can be one of the following values.
Value | Meaning |
---|---|
|
Erases the tape from the current position to the end of the current partition. |
|
Writes an erase gap or end-of-data marker at the current position. |
[in] bImmediate
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 value
If the function succeeds, the return value is NO_ERROR.
If the function fails, it can return one of the following error codes.
Error code | Description |
---|---|
|
An attempt to access data before the beginning-of-medium marker failed. |
|
A reset condition was detected on the bus. |
|
The partition information could not be found when a tape was being loaded. |
|
The end-of-tape marker was reached during an operation. |
|
A filemark was reached during an operation. |
|
The block size is incorrect on a new tape in a multivolume partition. |
|
The tape that was in the drive has been replaced or removed. |
|
The end-of-data marker was reached during an operation. |
|
There is no media in the drive. |
|
The tape driver does not support a requested function. |
|
The tape could not be partitioned. |
|
A setmark was reached during an operation. |
|
An attempt to lock the ejection mechanism failed. |
|
An attempt to unload the tape failed. |
|
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.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | winbase.h (include Windows.h) |
Library | Kernel32.lib |
DLL | Kernel32.dll |