Platform SDK: Files and I/O |
The GetTapeParameters function retrieves information that describes the tape or the tape drive.
DWORD GetTapeParameters( HANDLE hDevice, // handle to device DWORD dwOperation, // information type LPDWORD lpdwSize, // information LPVOID lpTapeInformation // tape media or drive information );
Value | Description |
---|---|
GET_TAPE_MEDIA_INFORMATION | Retrieves information about the tape in the tape device. |
GET_TAPE_DRIVE_INFORMATION | Retrieves information about the tape device. |
If dwOperation is GET_TAPE_DRIVE_INFORMATION, lpTapeInformation points to a TAPE_GET_DRIVE_PARAMETERS structure.
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. |
The block size range values (maximum and minimum) returned by the GetTapeParameters function called with the dwOperation parameter set to the GET_TAPE_DRIVE_INFORMATION value will indicate system limits, not drive limits. However, it is the tape drive device and the media present in the drive that determine the true block size limits. Thus, an application may not be able to set all the block sizes mentioned in the range obtained by specifying GET_TAPE_DRIVE_INFORMATION in dwOperation.
Windows NT/2000: Requires Windows NT 3.1 or later.
Header: Declared in Winbase.h; include Windows.h.
Library: Use Kernel32.lib.
Tape Backup Overview, Tape Backup Functions, CreateFile, SetTapeParameters, TAPE_GET_DRIVE_PARAMETERS, TAPE_GET_MEDIA_PARAMETERS