User manual

CAN API reference

CANErrorMessage

CANErrorMessage — Returns a description of the given error code as a text string.

Syntax

#include <AnaGateDllCAN.h>

int CANErrorMessage(int nRetCode, char * pcMessage, int nMessageLen);

Parameter

nRetCode Error code for which the error description is to be determined.

pcMessage Data buffer that is to accept the error description.

nMessageLen Size in bytes of the transferred data buffer.

Return value

Actual size of the returned description.

Description

Returns a textual description of the parsed error code (see Appendix A, Return Codes). If the destination

buffer is not big enough to store the text, the text is shortened to the specified buffer size.

See the following example in C/C++ language.

int nRC;

char cBuffer[200];

int nRC;

//... call a API function here

CANErrorMessage(nRC, cBuffer, 200);

std::cout << "Fehler: " << cBuffer << std::endl;