SetTapePosition function (winbase.h)

Article
10/13/2021

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.

Value	Meaning
TAPE_ABSOLUTE_BLOCK 1L	Moves the tape to the device-specific block address specified by the dwOffsetLow and dwOffsetHigh parameters. The dwPartition parameter is ignored.
TAPE_LOGICAL_BLOCK 2L	Moves the tape to the block address specified by dwOffsetLow and dwOffsetHigh in the partition specified by dwPartition.
TAPE_REWIND 0L	Moves the tape to the beginning of the current partition. The dwPartition, dwOffsetLow, and dwOffsetHigh parameters are ignored.
TAPE_SPACE_END_OF_DATA 4L	Moves the tape to the end of the data on the partition specified by dwPartition.
TAPE_SPACE_FILEMARKS 6L	Moves the tape forward (or backward) the number of filemarks specified by dwOffsetLow and dwOffsetHigh in the current partition. The dwPartition parameter is ignored.
TAPE_SPACE_RELATIVE_BLOCKS 5L	Moves the tape forward (or backward) the number of blocks specified by dwOffsetLow and dwOffsetHigh in the current partition. The dwPartition parameter is ignored.
TAPE_SPACE_SEQUENTIAL_FMKS 7L	Moves the tape forward (or backward) to the first occurrence of n filemarks in the current partition, where n is the number specified by dwOffsetLow and dwOffsetHigh. The dwPartition parameter is ignored.
TAPE_SPACE_SEQUENTIAL_SMKS 9L	Moves the tape forward (or backward) to the first occurrence of n setmarks in the current partition, where n is the number specified by dwOffsetLow and dwOffsetHigh. The dwPartition parameter is ignored.
TAPE_SPACE_SETMARKS 8L	Moves the tape forward (or backward) the number of setmarks specified by dwOffsetLow and dwOffsetHigh in the current partition. The dwPartition parameter is ignored.

[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
ERROR_BEGINNING_OF_MEDIA 1102L	An attempt to access data before the beginning-of-medium marker failed.
ERROR_BUS_RESET 1111L	A reset condition was detected on the bus.
ERROR_DEVICE_NOT_PARTITIONED 1107L	The partition information could not be found when a tape was being loaded.
ERROR_END_OF_MEDIA 1100L	The end-of-tape marker was reached during an operation.
ERROR_FILEMARK_DETECTED 1101L	A filemark was reached during an operation.
ERROR_INVALID_BLOCK_LENGTH 1106L	The block size is incorrect on a new tape in a multivolume partition.
ERROR_MEDIA_CHANGED 1110L	The tape that was in the drive has been replaced or removed.
ERROR_NO_DATA_DETECTED 1104L	The end-of-data marker was reached during an operation.
ERROR_NO_MEDIA_IN_DRIVE 1112L	There is no media in the drive.
ERROR_NOT_SUPPORTED 50L	The tape driver does not support a requested function.
ERROR_PARTITION_FAILURE 1105L	The tape could not be partitioned.
ERROR_SETMARK_DETECTED 1103L	A setmark was reached during an operation.
ERROR_UNABLE_TO_LOCK_MEDIA 1108L	An attempt to lock the ejection mechanism failed.
ERROR_UNABLE_TO_UNLOAD_MEDIA 1109L	An attempt to unload the tape failed.
ERROR_WRITE_PROTECT 19L	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