Skip to Content
Information
This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

ARGetTextForErrorMessage

Warning

Note

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).

Privileges

All users.

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.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

AR System 21.05