SetTapePosition function (winbase.h)
The SetTapePosition function sets the tape position on the specified device.
Syntax
DWORD SetTapePosition(
[in] HANDLE hDevice,
[in] DWORD dwPositionMethod,
[in] DWORD dwPartition,
[in] DWORD dwOffsetLow,
[in] DWORD dwOffsetHigh,
[in] BOOL bImmediate
);
Parameters
[in] hDevice
Handle to the device on which to set the tape position. This handle is created by using the CreateFile function.
[in] dwPositionMethod
Type of positioning to perform. This parameter must be one of the following values.
[in] dwPartition
Partition to position within. If dwPartition is zero, the current partition is used. Partitions are numbered logically from 1 through n, where 1 is the first partition on the tape and n is the last.
[in] dwOffsetLow
Low-order bits of the block address or count for the position operation specified by the dwPositionMethod parameter.
[in] dwOffsetHigh
High-order bits of the block address or count for the position operation specified by the dwPositionMethod parameter. If the high-order bits are not required, this parameter should be zero.
[in] bImmediate
Indicates whether to return as soon as the move operation begins. If this parameter is TRUE, the function returns immediately; if FALSE, the function does not return until the move 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 | 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
If the offset specified by dwOffsetLow and dwOffsetHigh specifies the number of blocks, filemarks, or setmarks to move, a positive offset moves the tape forward to the end of the last block, filemark, or setmark. A negative offset moves the tape backward to the beginning of the last block, filemark, or setmark. If the offset is zero, the tape does not move.
To obtain information about the status, capabilities, and capacities of tape drives and media, call 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 |