ValidateSession

IVI Library

Ivi_ValidateSession

Usage

ViStatus Ivi_ValidateSession(ViSession vi);

Purpose

This function checks an IVI session handle for validity. If the session is invalid, it returns an error code but does not set the primary error code, secondary error code, or error elaboration string for the current thread.

Parameters

Name Type Description
vi ViSession

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

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