ARGetTextForErrorMessage

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves the message text for the specified error from the local catalog (in the local language). The length of the text is limited by AR_MAX_MESSAGE_SIZE (255 bytes).

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"

int ARGetTextForErrorMessage(
char *ARGetTextForErrorMessage (
int msgId)

Input arguments

msgId

The error number whose message text you want to retrieve. This number is provided in the messageNum member of ARStatusStruct.

Return values

return

The function return value is a pointer to the retrieved message text. You must free this memory after calling this function.