SetRangeTableEnd

IVI Library

Ivi_SetRangeTableEnd

Usage

ViStatus Ivi_SetRangeTableEnd(IviRangeTablePtr rangeTable, ViInt32 index);

Purpose

This function sets the termination entry for a dynamic range table you create with Ivi_RangeTableNew. Ivi_RangeTableNew automatically sets the last entry you create to be the termination entry. For example, if you specify 10 entries, Ivi_RangeTableNew marks the entry at index 9 to be the termination entry. Use this function if you want to move the termination entry to a lower index.

Parameters

Name Type Description
rangeTable IviRangeTablePtr

Pass the range table pointer you obtain from Ivi_RangeTableNew.

index ViInt32

Specify the 0-based index of the entry to be the termination entry.

Ivi_RangeTableNew automatically sets the last entry you create to be the termination entry. For example, if you specify 10 entries, Ivi_RangeTableNew marks the entry at index 9 to be the termination entry. Use this function if you want to move the termination entry to a lower index.

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.

Related Topic

IVI Status Codes