LabWindows/CVI

Content Type
Programming Language
Current manual
Table of Contents

GetGeneralErrorString

GetGeneralErrorString

char *GetGeneralErrorString (int errorCode);

Purpose

Returns the error message associated with the error code specified in the errorCode parameter. You can specify error codes defined by the following libraries or instrument drivers:

  • User Interface Library
  • Easy I/O instrument driver
  • Toolbox instrument driver
  • ActiveX Library
  • .NET Library
  • DataSocket instrument driver
  • Network Variable Library
  • Real-Time Utility Library
  • TDM Streaming Library
  • UDP Support Library

This function can be useful if you write code that contains calls to more than one of these libraries. Because these error codes do not overlap, this function can query the correct library for the error message. This function also returns error messages for certain National Instruments shared components.

Note  This function returns No description available for Easy I/O error codes if the Easy I/O instrument driver is not loaded and linked.

Parameters

Input
Name Type Description
errorCode int An error code returned by one of the following libraries:

  • User Interface Library
  • Easy I/O instrument driver
  • Toolbox instrument driver
  • ActiveX Library
  • .NET Library
  • DataSocket instrument driver
  • Network Variable Library
  • Real-Time Utility Library
  • TDM Streaming Library
  • UDP Support Library

Return Value

Name Type Description
errorDescription char * The error message associated with the error code. Do not modify or free this string.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later

Was this information helpful?