niFgen_SetCalUserDefinedInfo

NI-FGEN C Function

niFgen_SetCalUserDefinedInfo

ViStatus niFgen_SetCalUserDefinedInfo (ViSession vi, ViConstString info);

Purpose

Stores user-defined information in the onboard EEPROM. Call the niFgen_GetCalUserDefinedInfoMaxSize function to determine the number of characters that can be stored.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitExtCal function and identifies a particular instrument session.
info ViConstString Specifies the information string that should be stored in the EEPROM.

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