niFgen_SetWaveformNextWritePosition
ViStatus niFgen_SetWaveformNextWritePosition (ViSession vi, ViConstString channelName, ViInt32 waveformHandle, ViInt32 relativeto, ViInt32 offset);
Purpose
Sets the position in the waveform at which the next waveform data is written. This function allows you to write to arbitrary locations within the waveform. These settings apply only to the next write to the waveform specified by the waveformHandle parameter. Subsequent writes to that waveform begin where the last write left off, unless this function is called again. The waveformHandle passed in must have been created by a call to the niFgen_AllocateWaveform function or one of the following niFgen CreateWaveform functions:
- niFgen_CreateWaveformF64
- niFgen_CreateWaveformI16
- niFgen_CreateWaveformFromFileI16
- niFgen_CreateWaveformFromFileF64
- niFgen_CreateWaveformFromFileHWS
Parameters
| Input | ||||||
| Name | Type | Description | ||||
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. | ||||
| channelName | ViConstString | Specifies the channel on which to the waveform data should be loaded.
Default Value: "0" |
||||
| waveformHandle | ViInt32 | Specifies the handle of the arbitrary waveform previously allocated with the niFgen_AllocateWaveform function. | ||||
| relativeTo | ViInt32 | Specifies the reference position in the waveform. The position and offset together determine where to start loading data into the waveform.
Defined Values
|
||||
| offset | ViInt32 | Specifies the offset from relativeTo at which to start loading the data into the waveform. | ||||
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|