niScope_CheckAttributeViBoolean
- Updated2023-02-21
- 1 minute(s) read
niScope_CheckAttributeViBoolean
C Function Prototype
ViStatus niScope_CheckAttributeViBoolean (ViSession vi, ViConstString channelList, ViAttr attributeID, ViBoolean value);
Purpose
Verifies the validity of a value you specify for a ViBoolean attribute.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | The instrument handle you obtain from niScope_init that identifies a particular instrument session. |
| channelList | ViConstString | The channel to configure. For more information, refer to Channel String Syntax. |
| attributeID | ViAttr | The ID of an attribute |
| value | ViBoolean | The value that you want to verify for the attribute. Some values might not be valid depending on the current settings of the instrument session. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Reports the status of this operation. To obtain a text description of the status code,
call
niScope_GetErrorMessage.
To obtain additional information concerning the error
condition, use niScope_GetError
and
niScope_ClearError.
The general meaning of the status code is as follows:
|