Ivi_CheckBooleanRange
Usage
ViStatus Ivi_CheckBooleanRange(ViBoolean value, ViStatus errorCode);
Purpose
This function verifies that the ViBoolean value you specify is either VI_TRUE (1) or VI_FALSE (0).
If the value is not VI_TRUE or VI_FALSE, the function returns the error code you specify.
Parameters
| Name | Type | Description |
|---|---|---|
| value | ViBoolean |
Specify the value you want to check. |
| errorCode | ViStatus |
Specify the error code the function returns if the value you specify is not VI_TRUE or VI_FALSE. |
Return Value
Contains the status code that the function call returns. IVI engine functions can return error and warning values from several sets of status codes. Some status codes are unique to the IVI engine. Other status codes are the same codes that VISA Library functions return. Still others are error or warning values that functions in specific instrument drivers return. Each set of status codes has its own numeric range.
Regardless of the source of the status code, 0 always indicates success, a positive value indicates a warning, and a negative value indicates an error.