collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_GetAttributeViString Function


Attribute Accessors See Also



This routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.

Function Tree Node: \Boonton55xxx\Attribute Accessors\GetAttributeViString

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_GetAttributeViString(
 ViSession Vi,
 ViConstString RepCapIdentifier,
 ViAttr AttributeID,
 ViInt32 AttributeValueBufferSize,
 ViChar[] AttributeValue
);

Parameters

Vi

The ViSession handle that you obtain from the IviDriver_init or IviDriver_InitWithOptions function. The handle identifies a particular instrument session.

RepCapIdentifier

If the attribute applies to a repeated capability, the user passes a physical or virtual repeated capability identifier. Otherwise, the user passes VI_NULL or an empty string. For attributes requiring nested repeated capabilities, enter the names separated by a colon as in: "Window1:Trace2".

AttributeID

The ID of the attribute. The valid values for this parameter can be found in the driver header file.

AttributeValueBufferSize

The number of bytes in the ViChar array that the user specifies for the AttributeValue parameter.

AttributeValue

The buffer in which the function returns the current value of the attribute. Can be VI_NULL if AttributeValueBufferSize is 0.

Return Value

 

Success or failure code.

collapse_allSee Also

Reference

Attribute Accessors

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.