GetNumAttributes

IVI Library

Ivi_GetNumAttributes

Usage

ViStatus Ivi_GetNumAttributes(ViSession vi, ViInt32* numberOfAttributes);

Purpose

This function obtains the total number of attributes in the IVI session you specify. This includes all attributes that the IVI engine and the driver create, regardless of whether the IVI_VAL_NOT_SUPPORTED flag for the attribute is set.

Parameters

Name Type Description
vi ViSession

The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session.

numberOfAttributes ViInt32*

Returns the total number of attributes in the IVI session. This includes all attributes that the IVI engine and the driver create, regardless of whether the IVI_VAL_NOT_SUPPORTED flag for the attribute is set.

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