1. Parameters and Functions Reference Guide
  2. User Exit Functions
  3. GET_SESSION_CHARSET

GET_SESSION_CHARSET

Valid For

Extract and Replicat

Description

Use GET_SESSION_CHARSET to get the current user exit session character set. This character set can be set through callback function SET_SESSION_CHARSET. The character set of the user exit session indicates the encoding of any character-based callback structure members that are used between the user exit and the caller process (Extract, data pump, Replicat), including metadata such as (but not limited to):

  • database names and locales

  • table and column names

  • DDL text

  • error messages

  • character-type columns such as CHAR and NCHAR

  • date-time and numeric columns that are represented in string form

The valid values of the session character set are defined in the header file ucharset.h. This function can be called at any time that the user exit has control.

Syntax

#include usrdecs.h
short result_code;
session_def session_charset_def;
ERCALLBACK (GET_SESSION_CHARSET, &session_charset_def, &result_code);

Buffer

typedef struct
{
ULibCharSet  session_charset;
} session_def;

Input

None

Output

session_charset_def.session_charset

Return Values

EXIT_FN_RET_OK