RFmxWCDMA_ModAccFetchNumberOfDetectedChannels
- Updated2024-10-14
- 2 minute(s) read
RFmxWCDMA_ModAccFetchNumberOfDetectedChannels
int32 __stdcall RFmxWCDMA_ModAccFetchNumberOfDetectedChannels (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* numberOfDetectedChannels);
Purpose
Fetches the number of detected channels in a carrier for the ModAcc measurement.
Use "carrier<n>" as the selector string to read results from this function.
Parameters
| Input | ||
| Name | Type | Description |
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWCDMA_Initialize function. |
| selectorString | char[] | Specifies a selector string comprising of the signal name, result name, and carrier number. 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: "carrier0" "signal::sig1/carrier0" "result::r1/carrier0" "signal::sig1/result::r1/carrier0" You can use the RFmxWCDMA_BuildCarrierString function to build the selector string. |
| timeout | float64 | Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. |
| Output | ||
| Name | Type | Description |
| numberOfDetectedChannels | int32* | Returns the number of detected channels when you set the
RFMXWCDMA_ATTR_CHANNEL_CONFIGURATION_MODE attribute to RFMXWCDMA_VAL_CHANNEL_CONFIGURATION_MODE_AUTO_DETECT. If you set the RFMXWCDMA_ATTR_CHANNEL_CONFIGURATION_MODE attribute to RFMXWCDMA_VAL_CHANNEL_CONFIGURATION_MODE_USER_DEFINED or RFMXWCDMA_VAL_CHANNEL_CONFIGURATION_MODE_TEST_MODEL, this parameter returns the number of configured channels.
|
Return Value
| Name | Type | Description | ||||||||
| status | 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. To obtain a text description of the status code and additional information about the error condition, call the RFmxWCDMA_GetError function. The general meaning of the status code is as follows:
|
||||||||