ClassPrefix_CheckAttribute[type]

IVI Inherent Function

To form the ClassPrefix_ of the function name, use the prefix of the class driver with which you are working. For example, if you are working with the IviDmm class driver, use the prefix IviDmm_ to create the correct function name, IviDmm_CheckAttribute[type].

ClassPrefix_CheckAttributeViInt32
ClassPrefix_CheckAttributeViReal64
ClassPrefix_CheckAttributeViBoolean
ClassPrefix_CheckAttributeViSession
ClassPrefix_CheckAttributeViString

C Function Prototype

ViStatus ClassPrefix_CheckAttributeViInt32 (ViSession vi, ViConstString channel,ViAttr attributeID, ViInt32 attributeValue);

ViStatus ClassPrefix_CheckAttributeViReal64 (ViSession vi, ViConstString channel,ViAttr attributeID, ViReal64 attributeValue);

ViStatus ClassPrefix_CheckAttributeViBoolean (ViSession vi, ViConstString channel,ViAttr attributeID, ViBoolean attributeValue);

ViStatus ClassPrefix_CheckAttributeViSession (ViSession vi, ViConstString channel,ViAttr attributeID, ViSession attributeValue);

ViStatus ClassPrefix_CheckAttributeViString (ViSession vi, ViConstString channel,ViAttr attributeID, ViConstString attributeValue);

Purpose

These functions verify the validity of a value you specify for an attribute. A separate typesafe function exists for each possible attribute data type.

Parameters

Name	Type	Description
vi	ViSession	The instrument handle that you obtain from the ClassPrefix_init or ClassPrefix_InitWithOptions functions. The handle identifies a particular IVI session.
channel	ViConstString	If the attribute is channel-based, pass a channel string or virtual channel name. Otherwise, pass VI_NULL or an empty string. Note  None of the attributes of the IviDmm class are channel-based. Therefore you always pass VI_NULL or an empty string when accessing the IviDmm class driver.
attributeID	ViAttr	The ID of the attribute.
attributeValue	depends on the data type of the attribute	The value that you want to verify as a valid value for the attribute given the current settings of the instrument session.

Return Values