HP-UX

NAME

viGetAttribute − Retrieves the stat a specified attribute

SYNOPSIS

viGetAttribute(ViSession/ViEvent/ViFindList vi, ViAttr
attribute, ViPAttrState attrState);

Description

 
This function retrieves the state of an attribute for the specified session.
 

Parameters

vi An input parameter.  Unique logical identifier to a session, event, or find list. 
 

attribute An input parameter.   Resource attribute for which the state query is made. 
 

attrState An output parameter.  The state of the queried attribute for a specified resource.  The interpretation of the returned value is defined by the individual resource. Note that you must allocate space for character strings returned. 
 
 
 
 
NOTE The pointer passed to viGetAttribute must point to the exact type required for that attribute, ViUInt16, ViInt32, and so forth.  For example, when reading an attribute state that returns a ViChar, you must pass a pointer to that array.  You must also allocate space for the returned data.
 
 

Return Values

 
This is the functional return status.  It returns either a completion code or an error code as follows.
 
 

VI_SUCCESS Resource attribute retrieved successfully. 
 

VI_ERROR_INV_SESSION VI_ERROR_INV_OBJECT The given session or object reference is invalid (both are the same value). 
 

VI_ERROR_NSUP_ATTR The specified attribute is not defined by the referenced resource. 
 
 

See Also

 
viSetAttribute
 

AUTHOR

viGetAttribute was developed by HP
 

Hewlett-Packard Comapny  —  September 29, 1999