TDMS_SetNextReadPosition
- Updated2023-02-21
- 2 minute(s) read
TDMS_SetNextReadPosition
int TDMS_SetNextReadPosition (TDMSChannelHandle channel, __int64 offset, TDMSOffsetReferencePoint offsetReferencePoint);
Purpose
Configures the offset, relative to the specified channel, at which TDMS_AdvancedAsyncRead or TDMS_AdvancedSyncRead starts reading data from a .tdms file.
(Linux) This function is not supported.
Parameters
| Input | ||||||||
| Name | Type | Description | ||||||
| channel | TDMSChannelHandle | The channel relative to which the next read position will be set. | ||||||
| offset | __int64 | The offset of the next read position relative to the specified channel and specified offset reference point. If you set the offsetReferencePoint parameter to TDMS_OffsetRelativeToChannelStart, then the offset must be greater than or equal to zero. If you set the offsetReferencePoint parameter to TDMS_OffsetRelativeToChannelEnd, then the offset must be less than or equal to zero. Specify the offset in units of samples of the specified channel. If you use the disable buffering option of TDMS_AdvancedCreateFile or TDMS_AdvancedOpenFile, the read position you set must correspond to a file position that is on a hard disk sector boundary. You can obtain the sector size of the hard disk from the sectorSize output parameter of TDMS_AdvancedCreateFile or TDMS_AdvancedOpenFile. |
||||||
| offsetReferencePoint | TDMSOffsetReferencePoint | The reference point, relative to the specified channel, to which the specified offset is applied.
|
||||||
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. Unless otherwise stated, zero represents successful execution and a negative number represents the error code. Error codes are defined in cvi\include\cvitdms.h. |
Additional Information
Library: TDM Streaming Library
Include file: cvitdms.h
LabWindows/CVI compatibility: LabWindows/CVI 2013 and later
© 2016 National Instruments. All rights reserved.