IviACPwr_AbortCurrentRamp
- Updated2023-02-24
- 1 minute(s) read
ViStatus IviACPwr_AbortCurrentRamp (ViSession instrumentHandle, ViChar phaseName[]);
Purpose
This function aborts a current ramp. If a current ramp is not in progress, this function has no effect.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| instrumentHandle | ViSession | The ViSession handle that you obtain from the IviACPwr_init or IviACPwr_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| phaseName | ViChar[] | Specifies the name of the output phase. Pass the virtual output phase name that you assign to the instrument in the IVI Configuration utility. Virtual output phase names are aliases for instrument-specific output phase strings, which can differ from one instrument to another. With virtual output phase names, you can use and swap instruments without having to change the output phase names in your source code. Assign a virtual output phase name to an instrument-specific output phase through the IVI Configuration utility. This parameter accepts virtual output phase names you have assigned to the specific instrument you are using and also accepts the instrument-specific output phase names. Default Value: "" Note: You can specify the output phase name as a string variable or as a literal enclosed in double quotes. |