Ivi_ClassFunctionCapabilities
Usage
ViStatus Ivi_ClassFunctionCapabilities (ViSession vi, IviStringValueTable functionTable, ViChar capabilityString[], ViBoolean allFound);
Purpose
This function takes a string/value table with entries for all of the function IDs and names for a given IVI class and creates a comma-separated list of functions implemented by the specific driver.
Use this function in the <CLASSPREFIX>_ATTR_FUNCTION_CAPABILITIES attribute read callback to set the value of the attribute.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session. |
| functionTable | IviStringValueTable | The string/value table consisting of the following pairs of {Function ID, Function Name} values. where FunctionID is an integer representing a unique, class-specific ID for a function, and the Function Name is the name of the function without the class or specific driver prefix. Example: static IviStringValueTable functionTableEntries[] = { {kIviDmmIviInit, "IviDmm_IviInit"}, {kIviDmmInit, "IviDmm_init"}, {VI_NULL, VI_NULL} } |
| Output | ||
| Name | Type | Description |
| capabilityString | ViChar[] | Returns a comma-separated list of function names implemented by the specific driver. |
| allFound | ViBoolean | Returns VI_TRUE if all the functions passed in the Function Table parameter were implemented by the specific driver, returns VI_FALSE otherwise. You may pass VI_NULL for this parameter. |
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.