AlazarReadEx¶
Function Syntax¶
-
U32
AlazarReadEx
(HANDLE handle, U32 channelId, void * buffer, int elementSize, long record, INT64 transferOffset, U32 transferLength)¶ Read all or part of a record from an acquisition to on-board memory from on-board memory to a buffer in hsot memory. The record may be longer than 2 billion samples.
Use AlazarRead() or AlazarReadEx() to transfer records with less than 2 billion samples. Use AlazarReadEx() to transfer records with more than 2 billion samples.
- Return
- ApiSuccess upon success, or an error code. See RETURN_CODE for more detailed information.
- Note
- AlazarReadEx() is part of the single-port data acquisition API. It cannot be used with the dual-port AutoDMA APIs.
- Remark
- AlazarReadEx() can transfer segments of a record to on-board memory. This may be useful if a full record is too large to transfer as a single block, or if only part of a record is of interest.
- Parameters
handle
: Handle to boardchannelId
: channel identifier of record to readbuffer
: Buffer to receive sample dataelementSize
: number of bytes per samplerecord
: record in on-board memory to transfer to buffer (1-indexed).transferOffset
: The offset in samples from the trigger position in the record of the first sample in the record in on-board memory to transfer to the buffertransferLength
: The number of samples to transfer from the record in on-board memory to the buffer.