get_id function

Related topics

Contained in package wwnls_api.

Call this function to return a string ID specified by domain, subdomain, name, and language.

function get_id

(

p_domain in wwnls_strings$.domain%type,

p_sub_domain in wwnls_strings$.sub_domain%type default 'all',

p_name in wwnls_strings$.name%type,

p_language in wwnls_strings$.language%type

)

return wwnls_strings$.id%type;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_domain

The domain in which the message string should be found.

Example: WWS

Datatype: in wwnls_strings$Domain%type

p_sub_domain

The subdomain in which the message string should be found.

Example: TEXT, NAVBAR.

Datatype: in wwnls_strings$Name%type
Default: 'all'

p_name

The unique name of the message string.

Datatype: in wwnls_strings$Name%type

p_language

The NLS language name constant for the language to be returned.

Example: wwnls_api.AMERICAN

Datatype: in wwnls_strings$.language%type

Returns:

This function returns a string ID based on a specified domain, sub-domain, string name, and NLS language constant.

Exceptions:

If this function fails to execute, an NLS_EXECUTION_EXCEPTION is raised.

If the message string ID is not found, an NLS_ID_NOT_FOUND_EXCEPTION is raised.

Example:

l_string_id := wwnls_api.get_id

(

p_domain =>'IPORTAL',

p_sub_domain =>'TRAIN',

p_name => 'WELCOME',

p_language => wwnls_api.ARABIC

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_domain	The domain in which the message string should be found. Example: WWS Datatype: in wwnls_strings$Domain%type
p_sub_domain	The subdomain in which the message string should be found. Example: TEXT, NAVBAR. Datatype: in wwnls_strings$Name%type Default: 'all'
p_name	The unique name of the message string. Datatype: in wwnls_strings$Name%type
p_language	The NLS language name constant for the language to be returned. Example: wwnls_api.AMERICAN Datatype: in wwnls_strings$.language%type
Returns: This function returns a string ID based on a specified domain, sub-domain, string name, and NLS language constant. Exceptions: If this function fails to execute, an NLS_EXECUTION_EXCEPTION is raised. If the message string ID is not found, an NLS_ID_NOT_FOUND_EXCEPTION is raised. Example: l_string_id := wwnls_api.get_id ( p_domain =>'IPORTAL', p_sub_domain =>'TRAIN', p_name => 'WELCOME', p_language => wwnls_api.ARABIC );

Related topics
NLS API package	PDK PL/SQL API Reference - Home