Converts a status code returned by an instrument driver function into a user-readable string.

Syntax

ViStatus _VI_FUNC niDCPower_error_message(ViSession vi, ViStatus errorCode, ViChar errorMessage[IVI_MAX_MESSAGE_BUF_SIZE])

Parameters

NameDirectionTypeDescription
vi[in]ViSession

Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

errorCode[in]ViStatus

Specifies the status parameter that is returned from any of the NI-DCPower functions.

errorMessage[out]ViChar[IVI_MAX_MESSAGE_BUF_SIZE]

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.

Returns

Reports the status of this operation. To obtain a text description of the status code, call niDCPower_error_message. To obtain additional information concerning the error condition, call niDCPower_GetError. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors