Ivi_GetNthRepCapString
Usage
ViStatus Ivi_GetNthRepCapString(ViSession vi, ViChar repeatedCapabilityName[ ], ViInt32 Index, ViConstString* repeatedCapabilityIdentifier);
Purpose
The function returns the repeated capability string that is in the repeated capability table at an index you specify. The specific instrument driver specifies the contents of the table using Ivi_BuildRepCapTable and Ivi_AddToRepCapTable.
If the index you specify is greater than the number of strings in the table, the function sets the Repeated Capability Identifier parameter to VI_NULL and returns VI_SUCCESS.
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". |
| Index | ViInt32 |
A 1-based index into the channel table. If you pass an index that is greater than the number of strings in the table, the function sets the Channel String parameter to VI_NULL and returns VI_SUCCESS. |
| repeatedCapabilityIdentifier | ViConstString* |
Returns the repeated capability string that is in the repeated capability table at the index you specify. Do not modify the contents of the repeated capability string. If the Index parameter is greater than the number of strings in the table, the function sets this parameter to VI_NULL and returns VI_SUCCESS. |
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.