RFmxWLAN_BuildStreamString
- Updated2024-10-14
- 2 minute(s) read
RFmxWLAN_BuildStreamString
int32 __stdcall RFmxWLAN_BuildStreamString (char selectorString[], int32 streamNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Purpose
Creates the stream string.
Parameters
| Input | ||
| Name | Type | Description |
| selectorString | char[] | Specifies a selector string comprising of the signal name and 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 RFmxWLAN_BuildSignalString function to build the selector string. |
| streamNumber | int32 | Specifies the stream 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows:
|
||||||||