collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_GetNextCoercionRecord Function


Utility See Also



Returns the oldest record from the coercion record list. Records are only added to the list if RecordCoercions is True.

Function Tree Node: \Boonton55xxx\Utility\Get Next Coercion Record

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_GetNextCoercionRecord(
 ViSession Vi,
 ViInt32 CoercionRecordBufferSize,
 ViChar[] CoercionRecord
);

Parameters

Vi

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

CoercionRecordBufferSize

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

CoercionRecord

The coercion record string shall contain the following information: (1) The name of the attribute that was coerced. This can be the generic name, the COM property name, or the C defined constant. (2) If the attribute is channel-based, the name of the channel. The channel name can be the specific driver channel string or the virtual channel name that the user specified.(3) If the attribute applies to a repeated capability, the name of the repeated capability. The name can be the specific driver repeated capability token or the virtual repeated capability name that the user specified.(4) The value that the user specified for the attribute.(5) The value to which the attribute was coerced.

Return Value

 

Success or failure code.

collapse_allRequirements

Supported Models

All supported

collapse_allSee Also

Reference

Utility

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.