IviACPwr_QueryArbWaveformCatalog
- Updated2023-02-24
- 1 minute(s) read
ViStatus IviACPwr_QueryArbWaveformCatalog (ViSession instrumentHandle, ViInt32 catalogType, ViInt32 catalogBufferSize, ViChar catalog[]);
Purpose
This function returns a comma delimited string of user-defined and/or fixed vendor-defined waveform names currently stored in the AC power source.
To determine the number of additional user-defined waveforms that the power source can store, use the IVIACPWR_ATTR_AVAILABLE_WAVEFORM_COUNT attribute.
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 |
| catalogType | ViInt32 | Specifies whether the returned catalog string contains fixed vendor-defined and/or user-defined waveform names. Valid Values: Fixed - IVIACPWR_VAL_WAVEFORM_CATALOG_FIXED Request catalog of fixed vendor defined waveform names. User - IVIACPWR_VAL_WAVEFORM_CATALOG_USER Request catalog of user-defined waveform names. All - IVIACPWR_VAL_WAVEFORM_CATALOG_ALL Request catalog of all waveform names. Default Value: Fixed |
| catalogBufferSize | ViInt32 | The size of the user-allocated buffer. Default Value: None |
| Output | ||
| Name | Type | Description |
| catalog | ViChar[] | A user-allocated buffer to store a comma delimited string of waveform names currently stored in the AC power source. |