niRFSG_error_message

NI RF Signal Generators Help (NI-RFSG 18.1)


Edition Date: June 2018
Part Number: 371025V-01
View Product Info

Download Help (Windows Only)


NI-RFSG 18.1 Help
NI-RFSG 18.2.1 Help
NI-RFSG 19.1 Help

C Function Prototype

ViStatus niRFSG_error_message (ViSession vi, ViStatus errorCode, ViChar[] errorMessage);

Purpose

Converts an error code returned by an NI-RFSG function into a user-readable string.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840

Parameters

Input
Name Type Description
vi ViSession The ViSession handle that you obtain from niRFSG_init or niRFSG_InitWithOptions. The handle identifies a particular instrument session.

You can pass VI_NULL for this parameter. Passing VI_NULL is useful when niRFSG_init or niRFSG_InitWithOptions fails.

Default Value: VI_NULL

errorCode ViStatus Pass the status parameter that is returned from any NI-RFSG function.

Default Value: 0 (VI_SUCCESS)

Output
Name Type Description
errorMessage ViChar[] Returns the user-readable message string that corresponds to the status code you specify.

You must pass a ViChar array with at least 256 bytes to this parameter.

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. 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 error code, call the niRFSG_GetError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors

WAS THIS ARTICLE HELPFUL?

Not Helpful