Ivi_GetInvalidationList
Usage
ViStatus Ivi_GetInvalidationList(ViSession vi, ViAttr attributeID, IviInvalEntry** invalidationList, ViInt32* numberOfEntries);
Purpose
This function returns a list of all the invalidation dependency relationships for the session. The specific driver creates the dependency relationships using Ivi_AddAttributeInvalidation.
The function dynamically allocates an array of IviInvalEntry structures and returns a pointer to it. The last entry in the array is a termination entry that has IVI_ATTR_NONE (-1) in the attribute field. It also returns the number of items in the array, excluding the termination entry. When you are done with the list, you must free it by calling Ivi_DisposeInvalidationList.
You can pass VI_NULL for the Invalidation List parameter, in which case the function just returns the number of dependency relationships.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession |
The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session. |
| attributeID | ViAttr |
Pass the ID of an attribute for this parameter. The include file for a specific instrument driver defines constant names for all of the user-accessible attributes that apply to the driver. This includes attributes that the IVI engine defines, attributes that the instrument class defines, and attributes that are specific to the particular instrument. Each defined constant name begins with PREFIX_ATTR_, where PREFIX is the specific instrument prefix. For each IVI engine attribute, the specific driver include file uses the same constant name that appears in ivi.h, except that the specific instrument prefix replaces the IVI prefix. For example, ivi.h defines IVI_ATTR_CACHE, and the Fluke 45 include file, fl45.h, defines the following constant name: #define FL45_ATTR_CACHE IVI_ATTR_CACHE For each instrument class attribute, the specific driver include file uses the same constant name that appears in the instrument class include file, except that the specific instrument prefix replaces the class prefix. For example, the DMM class include file, ividmm.h, defines IVIDMM_ATTR_RANGE, and fl45.h defines the following constant name: #define FL45_ATTR_RANGE IVIDMM_ATTR_RANGE For each specific instrument attribute, the specific driver include file defines a constant name and assigns a value that is an offset from IVI_SPECIFIC_PUBLIC_ATTR_BASE. For example, fl45.h defines the following constant name: #define FL45_ATTR_HOLD_THRESHOLD \ (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 3L) For each attribute that is private to an instrument driver, the instrument driver source file defines a constant name and assigns a value that is an offset from IVI_SPECIFIC_PRIVATE_ATTR_BASE. For example, hp34401a.c defines the following constant name: #define HP34401A_ATTR_TRIGGER_TYPE \ (IVI_SPECIFIC_PRIVATE_ATTR_BASE + 1L) |
| invalidationList | IviInvalEntry** |
Returns the pointer to an array that contains all the invalidation dependency relationships for the session. The function dynamically allocates an array of IviInvalEntry structures and returns a pointer to it in this parameter. The last entry in the array is a termination entry that has IVI_ATTR_NONE (-1) in the attribute field. When you are done with the list, you must free it by calling Ivi_DisposeInvalidationList. You can pass VI_NULL for this parameter, in which case the function just returns the number of dependency relationships. |
| numberOfEntries | ViInt32* |
Returns the number of entries in the invalidation list, excluding the termination entry. |
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.