niFgen_self_test

ViStatus niFgen_self_test (ViSession vi, ViInt16* selfTestResult, ViChar[] selfTestMessage);

Purpose

Runs the instrument self-test routine and returns the test result(s).

Note  When used on some signal generators, the device is reset after the niFgen_self_test function runs. If you use the niFgen_self_test function, your device may not be in its previously configured state after the function runs.

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session.
Output
Name	Type	Description
selfTestResult	ViInt16	Contains the value returned from the instrument self-test. Zero means success. For any other code, refer to Error and Status Information. Self-Test Code Description 0 Passed self-test 1 Self-test failed
selfTestMessage	ViChar[]	Returns the self-test response string from the instrument. Refer to Error and Status Information for an explanation of the string contents. You must pass a ViChar array with at least 256 bytes.

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 can examine the status code from each call to an NI-FGEN function to determine if an error occurred. To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows: Value Meaning 0 Success Positive Values Warnings Negative Values Errors