Queries the value of a ViInt32 attribute.

Syntax

ViStatus _VI_FUNC niRFSA_GetAttributeViInt32(ViSession vi, ViConstString channelName, ViAttr attributeId, ViInt32 *value)

Remarks

You can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Parameters

NameDirectionTypeDescription
vi[in]ViSession

Identifies your instrument session. vi is obtained from the niRFSA_Init or niRFSA_InitWithOptions function.

channelName[in]ViConstString

Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.

attributeId[in]ViAttr

Pass the ID of an attribute.

value[out]ViInt32 *

Returns the current value of the attribute. Pass the address of a ViInt32 variable.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors