APUTranslateErrorCode() Function

Converts an error code returned by one of the APU functions into an English string that briefly describes the error code.

Category

View

Syntax

[Result=] APUTranslateErrorCode(iErrorCode, sTagMessage);

Arguments

iErrorCode

An integer error code, normally returned by most other APU functions.

sTagMessage

A message tag that receives the error message.

Remarks

This function returns the error message to a message tag as sTagMessage parameter. This function can fail if an unknown error code is passed.

Returns an integer error code.

Example

This example sets the message tag errmsg to "No instance available." if there is no instance 15 of Alarm Printer currently running.

Status = APUTranslateErrorCode(APUSetAlarmGroupText(15,"$system"), ErrMsg);