niDCPower_SetCalUserDefinedInfo

NI-DCPower Function Reference

niDCPower_SetCalUserDefinedInfo

ViStatus niDCPower_SetCalUserDefinedInfo (ViSession vi, ViConstString info);

Purpose

Stores a user-defined string of characters in the device onboard EEPROM. If the string is longer than the maximum allowable size, it is truncated. This function overwrites any existing user-defined information.

If you call this function in a regular session, info is immediately changed. If you call this function in an external calibration session, info is changed only after you close the session using the niDCPower_CloseExtCal function with action set to NIDCPOWER_VAL_COMMIT.

Parameters

Input
Name Type Description
vi ViSession Identifies a particular instrument session. vi is obtained from the niDCPower_init or niDCPower_InitWithOptions function.
info ViConstString Specifies the string to store in the device onboard EEPROM.

Return Value

Name Type Description
StatusViStatusReports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.