RFmxInstr_BuildCalibrationPlaneString

RFmx SpecAn 19.1 Help

Edition Date: October 2019

Part Number: 374264N-01

»View Product Info

DOWNLOAD (Windows Only)


RFmx SpecAn 19.1 Help
RFmx SpecAn 20.0 Help

int32 __stdcall RFmxInstr_BuildCalibrationPlaneString( char calibrationPlaneName[], int32 selectorStringLength, char selectorString[] );

Purpose

Creates the selector string to use with External Attenuation Table functions.

Parameters

Input
Name Type Description
signalName char[] Specifies the calibration plane name for building the selector string. This input accepts the calibration plane name with or without the "calplane::" prefix.

Example:

""

"calplane::plane0"

"plane0"
selectorStringLength int32 Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
Output
Name Type Description
selectorString char[] Returns the selector string created by this function. You can pass NULL for this parameter if selectorStringLength is set to 0, which will return the minimum buffer size required to create the signal string. If the selectorString buffer is not large enough to build the signal string, the function returns an error.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxInstr_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful