isc_license_get_msg()

From InterBase
Jump to: navigation, search

Go Up to API Function Reference


Returns the text of an error code.

Syntax

unsigned short isc_get_msg(short msg_no, char *msg,
unsigned short msg_len)

Parameter Type Description

<msg_no>

short

A message number returned by one of the other isc_license_*() functions

<msg>

char *

  • A character buffer for the message that corresponds to <msg_no>
  • Must be allocated by the programmer
  • Recommended length is ISC_LICENSE_MAX_MESSAGE_LEN

<msg_len>

short

The length of <msg>

Description

When passed an error code from one of the other four functions in the License API, isc_license_get_msg() returns the text of the corresponding error message in the <msg> buffer.

Return value

isc_license_get_msg() returns zero if it succeeds. Otherwise, it returns the length that <msg> must have in order to contains the message text.

Advance To: