niFgen_QueryArbSeqCapabilities

NI-FGEN C Function

niFgen_QueryArbSeqCapabilities

ViStatus niFgen_QueryArbSeqCapabilities (ViSession vi, ViInt32* maximumNumberofSequences, ViInt32* minimumSequenceLength, ViInt32* maximumSequenceLength, ViInt32* maximumLoopCount);

Purpose

Returns the attributes of the signal generator that are related to creating arbitrary sequences (the NIFGEN_ATTR_MAX_NUM_SEQUENCES, NIFGEN_ATTR_MIN_SEQUENCE_LENGTH, NIFGEN_ATTR_MAX_SEQUENCE_LENGTH, and NIFGEN_ATTR_MAX_LOOP_COUNT attributes).

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.
Output
Name Type Description
maximumNumberofSequences ViInt32* Returns the maximum number of arbitrary waveform sequences that the signal generator allows. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_NUM_SEQUENCES attribute.
minimumSequenceLength ViInt32* Returns the minimum number of arbitrary waveforms the signal generator allows in a sequence. NI-FGEN obtains this value from the NIFGEN_ATTR_MIN_SEQUENCE_LENGTH attribute.
maximumSequenceLength ViInt32* Returns the maximum number of arbitrary waveforms the signal generator allows in a sequence. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_SEQUENCE_LENGTH attribute.
maximumLoopCount ViInt32* Returns the maximum number of times the signal generator can repeat an arbitrary waveform in a sequence. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_LOOP_COUNT attribute.

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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors