Ivi_CoerceBoolean
Usage
ViStatus Ivi_CoerceBoolean(ViBoolean* value);
Purpose
This function coerces a value you specify to a valid ViBoolean value. If the value is non-zero, the function changes it to VI_TRUE (1).
Parameters
| Name | Type | Description |
|---|---|---|
| value | ViBoolean* |
Pass the address of the value you want to coerce. If the value is non-zero, the function changes it to VI_TRUE (1). |
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.