Admin Production ni-theme
Current Publication

OGLGetErrorString

LabWindows/CVI

OGLGetErrorString

void OGLGetErrorString (int errorCode, char buffer[], int bufferLength);

Purpose

Returns English descriptions of error codes defined by the following libraries or instrument drivers:

The User Interface Library
The OGL instrument driver

This can be useful if you write code that contains calls to more than one of these libraries. Since these error codes do not overlap, this function can query the correct library for the error string.

Parameters

Input
Name Type Description
errorCode int Pass the error code for which to retrieve the English description.

The error code must be a User Interface Library or OGL error code.
bufferLength int Specifies the length of the buffer.
Output
Name Type Description
buffer char [] The buffer to hold the returned null–terminated error string.

Return Value

None.

Additional Information

Library: OpenGL 3D Plotting Control

Include file: custctrl\cviogl.h

LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later

Examples

Refer to the following examples that use the OGLGetErrorString function:

  • userint\custctrl\cviogl\ogldraw.cws

    Open example
  • userint\custctrl\cviogl\simple.cws

    Open example