ni568x_CheckAttributeViBoolean

RF Power Sensor Devices Help (NI-568x 18.0)

Edition Date: May 2018

Part Number: 373127F-01

»View Product Info
Download Help (Windows Only)

ni568x_CheckAttributeViBoolean(ViSession vi, ViConstString channelName, ViAttr attribute, ViBoolean value);

Purpose

Checks the validity of a value you specify for a ViBoolean attribute.

Supported Devices: NI 5680/5681/5683/5684

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the ni568x_init or ni568x_InitWithOptions function and identifies a particular instrument session.
channelName 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, pass VI_NULL or an empty string. The only valid channel name is "0".
attribute ViAttr Specifies the ID of the attribute to check.

From the function panel window, use this control as follows:

- Click the control or press <ENTER>, <spacebar>, or <Ctrl-down arrow> to display a dialog box containing a hierarchical list of the available attributes. Attributes with values that cannot be set are dimmed. Help text is shown for each attribute. Select an attribute by double-clicking its name or by highlighting its name and then pressing <ENTER>.

Read-only attributes appear dimmed in the listbox. If you select a read-only attribute, you receive an error message.

A ring control at the top of the dialog box allows you to see either all of the IVI attributes or only the ViBoolean attributes. If you choose to see all IVI attributes, the data types appear to the right of the attribute names in the listbox. Attributes with data types other than ViBoolean are dimmed. If you highlight an attribute data type that is dimmed, LabWindows/CVI transfers you to the function panel for the function that corresponds to the data type.

- If you want to enter a variable name, press <Ctrl-T> to change this ring control to a manual input box.

- If the attribute specified in this ring control has named constants as valid values, you can view the constants by moving to the attributeValue control and pressing <ENTER>.
value ViBoolean Specifies the value you want to verify as valid for the attribute specified in the attributeID parameter.

From the function panel window, use this control as follows:

If the attribute currently shown in the attributeID ring control has constants as valid values, press <ENTER> to view a list of the constants. Select a value by double-clicking it or by selecting it and then pressing <ENTER>.

Note: Valid values depend on the current settings of the device session.

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. Examine the status code from each call to an NI-568x function to determine whether an error has occurred.

To obtain a text description of the status code, call the ni568x_error_message function. To obtain additional information about the error condition, call the ni568x_GetError function. To clear the error information from NI-568x, call the ni568x_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors


WAS THIS ARTICLE HELPFUL?

Not Helpful