niHWS_GetErrorString

NI-HWS C Function Reference

niHWS_GetErrorString

Specific Function

C Function Prototype

tHWS_Status niHWS_GetErrorString  (tHWS_Status errorCode, long stringSize, char errorString);

Purpose

This function provides the error description for the specified error code.

Parameters

Name Type Description
errorCode tHWS_Status Error code for which the function provides a description.
stringSize long The number of characters that the string allocated for the errorString parameter can hold.

If stringSize is 0 and no error occurs, the actual size of the error string, including the end of string termination character, is returned in the status parameter.

errorString char[] The description for the provided error code.