RFmxNR_BuildListStepString
- Updated2025-04-08
- 2 minute(s) read
Creates the list step string.
Syntax
int32 __stdcall RFmxNR_BuildListStepString(char listName[], char resultName[], int32 stepNumber, int32 selectorStringOutLength, char selectorStringOut[])
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| listName | [in] | char | This parameter specifies the list name. This input accepts the list name with or without the "list::" prefix. The default value is "" (empty string). Example: |
| resultName | [in] | char | This parameter specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix. The default value is "" (empty string) for the default result instance. Example: |
| stepNumber | [in] | int32 | This parameter specifies the step number for building the selector string. The default value is 0, which corresponds to the first step. When you use -1 as the step number, all steps are considered. |
| selectorStringOutLength | [out] | 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. |
| selectorStringOut | [out] | char | This parameter returns the selector string created by this function. |
Returns
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.
To obtain a text description of the status code and additional information about the error condition, call the RFmxNR_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |