NI RFmx WLAN Build String Functions - ni/grpc-device GitHub Wiki
- RFmxWLAN_BuildSignalString
- RFmxWLAN_BuildGateString
- RFmxWLAN_BuildOffsetString
- RFmxWLAN_BuildUserString
- RFmxWLAN_BuildSegmentString
- RFmxWLAN_BuildStreamString
- RFmxWLAN_BuildChainString
int32 __stdcall RFmxWLAN_BuildSignalString (char signalName[], char resultName[], int32 selectorStringLength, char selectorString[]);
Creates a selector string.
| 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. |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildGateString (char selectorString[], int32 gateNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the gate string to use as the selector string.
| 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. |
| gateNumber | int32 | Specifies the gate 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildOffsetString (char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the offset string to use as the selector string.
| 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. |
| 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildUserString (char selectorString[], int32 userNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the user string to use as the selector string.
| 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. |
| userNumber | int32 | Specifies the user 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildSegmentString (char selectorString[], int32 segmentNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates a segment string.
| 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. |
| segmentNumber | int32 | Specifies the segment 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildStreamString (char selectorString[], int32 streamNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the stream string.
| 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
int32 __stdcall RFmxWLAN_BuildChainString (char selectorString[], int32 chainNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates a chain string. Use "segment<n>" as the selector string to read results from this function.
| Input | ||
|---|---|---|
| Name | Type | Description |
| selectorString | char[] | Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used. You can also pass selectorString from the RFmxWLAN_BuildSegmentString function as an input to this function. Example: "segment0" "signal::sig1/segment0" "result::r1/segment0" "signal::sig1/result::r1/segment0" You can use the RFmxWLAN Build Segment String function to build the selector string. |
| chainNumber | int32 | Specifies the chain 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[] | ADD_PARAM_DESCRIPTION |
| 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: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |