Ivi_GetViInt32EntryFromIndex
Usage
ViStatus Ivi_GetViInt32EntryFromIndex(ViInt32 tableIndex, IviRangeTablePtr rangeTable, ViInt32* discreteOrMinValue, ViInt32* maxValue, ViInt32* coercedValue, ViString* commandString, ViInt32* commandValue);
Purpose
This function extracts the range table entry that is at the 0-based index you specify. The function returns the contents of the entry.
If you specify an index that is less than 0 or greater than or equal to the number of entries in the table, the function returns an IVI_ERROR_INVALID_VALUE error.
The function returns the discreteOrMinValue, maxValue, and coercedValue fields as ViInt32 values.
Parameters
| Name | Type | Description |
|---|---|---|
| tableIndex | ViInt32 |
Specify the 0-based index of the range table entry you want to extract. |
| rangeTable | IviRangeTablePtr |
Specify the address of the range table from which to extract the entry at the index you specify. |
| discreteOrMinValue | ViInt32* |
If the search succeeds, this parameter returns the value of the discreteOrMinValue field of the entry. You can pass VI_NULL for the parameter if you are not interested in this value. |
| maxValue | ViInt32* |
If the search succeeds, this parameter returns the value of the maxValue field of the entry. You can pass VI_NULL for the parameter if you are not interested in this value. |
| coercedValue | ViInt32* |
Specify the coerced value that you want to find in the range table. |
| commandString | ViString* |
If the search succeeds, this parameter returns the pointer in the cmdString field of the entry. Do not change the contents of the string. You can pass VI_NULL for the parameter if you are not interested in this value. |
| commandValue | ViInt32* |
Specify the command value that you want to find in the range table. |
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.