Ivi_BuildRepCapTable
Usage
ViStatus Ivi_BuildRepCapTable(ViSession vi, ViChar repeatedCapabilityName[ ], ViChar Identifiers[ ]);Purpose
This function creates a repeated capability table for an IVI session. A repeated capability table consists of a name that identifies the repeated capability and the identifier strings that are valid for the instrument session. When you create attributes with the Ivi_AddRepeatedAttribute functions, you set the Repeated Capability parameter to the name of the repeated capability to which the attribute applies.
The repeated capability table must be created before attributes can be added for the repeated capability. To add identifier strings to an existing repeated capability table, call Ivi_AddToRepCapTable. To restrict an attribute to a subset of repeated capability identifiers, call Ivi_RestrictAttrToInstances. If you call this function more than once for the same repeated capability, the function will return the IVI_ERROR_REPEATED_CAPABILITY_ALREADY_EXISTS error.
The IVI engine maintains the repeated capability table for the session. If the user defines any virtual repeated capability names in the configuration store, the IVI engine associates the virtual names with the entries in the table.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession |
The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session. |
| repeatedCapabilityName | ViChar[ ] |
Pass a string containing the name of the repeated capability on which to operate. For instance, if you are working with the table of channel names, pass in the string "Channel". |
| Identifiers | ViChar[ ] |
Pass a string containing a list of additional repeated capability identifiers you want to add to the repeated capability table. You must separate repeated capability identifiers with commas. You can include spaces after the commas. For example, to add "3" and "4" as valid identifiers for the repeated capability, pass "3, 4". |
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.