get_string_record function (domain, sub-domain, name, language)

get_string_record function (domain, subdomain, name, language)

Related topics

Contained in package wwnls_api.

Call this function to get a message record. If the translation specified in p_language is not found, the base message string is returned.

Notes:

A base message string is the base string that was created with the add_string function, in the current domain and subdomain, and with the specified name.

String records in the specified translation may be created only after the base string is added.

function get_string_record

(

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 string_record;

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.

Note: The default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

Example: TEXT, NAVBAR

Datatype: in wwnls_strings$.sub_domain%type
Default: 'all'

p_name

A unique name for a 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:

If the translation specified in p_language is found, this function returns a message record based on domain, subdomain, string name, and language name. If the translation specified in p_language is not found, this function returns the same information for the base string.

Exceptions:

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

Example:

declare

l_desc wwnls_api.string_record;

begin

l_desc := wwnls_api.get_string_record
(

p_domain =>wwc,
p_sub_domain =>'typ',
p_name =>'desc_number',
p_language =>wwctx_api.get_nls_language
);

end;

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. Note: The default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains. Example: TEXT, NAVBAR Datatype: in wwnls_strings$.sub_domain%type Default: 'all'
p_name	A unique name for a 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: If the translation specified in p_language is found, this function returns a message record based on domain, subdomain, string name, and language name. If the translation specified in p_language is not found, this function returns the same information for the base string. Exceptions: If this function fails to execute, an NLS_EXECUTION_EXCEPTION is raised. Example: declare l_desc wwnls_api.string_record; begin l_desc := wwnls_api.get_string_record ( p_domain =>wwc, p_sub_domain =>'typ', p_name =>'desc_number', p_language =>wwctx_api.get_nls_language ); end;

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