Prefix_Disable
ViStatus Prefix_Disable (ViSession vi);
Purpose
Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected.
Parameter
| Input | ||
| Name | Type | Description |
|---|---|---|
| vi | ViSession | Unique identifier for an IVI session. |
Return Values
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.
Related Topic
Implementation Requirements
Call Ivi_LockSession to lock the IVI session.
If simulation is disabled, send the appropriate commands to return the instrument to a quiescent state. Remember to call Ivi_SetNeedToCheckStatus with VI_TRUE before you perform the instrument I/O.
Finally, call Ivi_UnlockSession to unlock the IVI session.
Be sure to document the state in which the Prefix_Disable function places the instrument. Include the information in the function panel help for the Prefix_Disable function.