niRFSA_GetNumberOfSpectralLines
ViStatus = niRFSA_GetNumberOfSpectralLines( ViSession vi, ViConstString channelList, ViInt32* numberOfSpectralLines);
Purpose
Returns the number of spectral lines that NI-RFSA will compute with the current power spectrum configuration.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. |
| channelList | ViConstString | Identifies channels to apply settings. Use "" or VI_NULL to specify all channels. |
| Output | ||
| Name | Type | Description |
| numberOfSpectralLines | ViInt32* | Returns the value of the NIRFSA_ATTR_NUMBER_OF_SPECTRAL_LINES attribute. |
Return Value
| Name | Type | Description | ||
| status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred. To obtain a text description of the status code, call the niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
|---|---|---|---|---|
| 0 | Success | |||
| Positive Values | Warnings | |||
| Negative Values | Errors |