RFmxDemod_BuildSignalString

RFmx Demod 19.1 Help

Edition Date: October 2019

Part Number: 374641M-01

»View Product Info

Download Help (Windows Only)


RFmx Demod 19.1 Help
RFmx Demod 20.0 Help

int32 __stdcall RFmxDemod_BuildSignalString (char signalName[], char resultName[], int32 selectorStringLength, char selectorString[]);

Purpose

Creates a selector string for use with Configuration or Fetch attributes and functions.

You must provide a char array to serve as a buffer for the value. Pass the number of bytes in the buffer as the selectorStringLength parameter.

If you want to call this function only to get the required buffer size, you must pass 0 for selectorStringLength and NULL for the selectorString buffer.

Parameters

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

Example:

""

"signal::sig1"

"sig1"

resultName char[] Specifies the result name for building the selector string. This input accepts the result name with or without the "result::" prefix.

Example:

""

"result::r1"

"r1"

selectorStringLength int32 Specifies the length of the string that is returned by the selectorString parameter. To get the minimum buffer size required to build the selector string, set the selectorStringLength parameter to 0.
Output
Name Type Description
selectorString char[] Returns the selector string created by this function. You can pass NULL for this parameter if the selectorStringLength parameter is set to 0, which returns 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
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxDemod_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