get_string_record function (id, language)

Related topics

Contained in package wwnls_api.

Call this function to get a message record for a message string ID and an NLS language constant.

Notes:

If p_language is null, the message record specified by p_id is returned.

If p_language is not null, the message record for the translation of p_id, in the language specified by p_language, is returned.

function get_string_record

(

p_id in wwnls_strings$.id%type,

p_language in wwnls_strings$.language%type default null

)

return string_record;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_id

A message record ID number.

Datatype: in wwnls_strings$.id%type

p_language

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

Example: wwnls_api.AMERICAN

Datatype: in wwnls_strings$.language%type
Default: null

Returns:

If p_language is null, the message record specified by p_id is returned. If p_language is not null, the message record specified by p_id is returned in the specified language.

Exceptions:

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

Example:

l_string_record := wwnls_api.get_string_record

(

p_id => 12784,

p_language => wwnls_api.AMERICAN,

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_id	A message record ID number. Datatype: in wwnls_strings$.id%type
p_language	The NLS language name constant for the language to be retrieved. Example: wwnls_api.AMERICAN Datatype: in wwnls_strings$.language%type Default: null
Returns: If p_language is null, the message record specified by p_id is returned. If p_language is not null, the message record specified by p_id is returned in the specified language. Exceptions: If this function fails to execute, an NLS_EXECUTION_EXCEPTION is raised. Example: l_string_record := wwnls_api.get_string_record ( p_id => 12784, p_language => wwnls_api.AMERICAN, );

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