NI RFmx Bluetooth Build String Functions

Build String Functions

• RFmxBT_BuildSignalString
• RFmxBT_BuildOffsetString
• RFmxBT_BuildSlotString

RFmxBT_BuildSignalString

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

Purpose

Creates a selector string.

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 selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
selectorString	char[]	Returns the selector string created by this function.

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 RFmxBT_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxBT_BuildOffsetString

int32 __stdcall RFmxBT_BuildOffsetString (char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the offset string.

Parameters

Input
Name	Type	Description
selectorString	char[]	Specifies a selector string comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. Example: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxBT_BuildSignalString function to build the selector string.
offsetNumber	int32	Specifies the offset number for building the selector string.
selectorStringOutLength	int32	Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name	Type	Description
selectorStringOut	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
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 RFmxBT_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxBT_BuildSlotString

int32 __stdcall RFmxBT_BuildSlotString (char selectorString[], int32 slotNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates a slot string for use with the TXP configuration or fetch attributes and functions.

Parameters

Input
Name	Type	Description
selectorString	char[]	Specifies a selector string comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. Example: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxBT_BuildSignalString function to build the selector string.
slotNumber	int32	Specifies the slot number for building the selector string.
selectorStringOutLength	int32	Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name	Type	Description
selectorStringOut	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
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 RFmxBT_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors