Analytica GmbH AnaGate CAN duo User Manual download pdf (Page 51)

SPI API reference

SPIErrorMessage

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

Syntax

#include <AnaGateDllCAN.h>

int SPIErrorMessage(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

SPIErrorMessage(nRC, cBuffer, 200);

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

1 2 ... 46 47 48 49 50 51 52 53 54 55 56 ... 82 83

No comments

Analytica GmbH AnaGate CAN duo User Manual Page 51