get_base_string_record function

Related topics

Contained in package wwnls_api.

Call this function to return the base string record, given the domain, subdomain and name.

function get_base_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

)
return string_record;

Version: Oracle9iAS Portal 9.0.2 or later

Parameters:

p_domain

The domain for the message string.

Example: WWS

Datatype: in wwnls_strings$.domain%type

p_sub_
domain

The subdomain for the message string.

Note: The default 'all' refers to the name of a specific sub-domain. 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

Returns:

This function returns the base string_record.

Exceptions:

If this function fails to execute, NLS_EXECUTION_EXCEPTION is raised.

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

Example:

declare

l_string_record wwnls_api.string_record;

begin

l_string_record := wwnls_api.get_base_string_record(

p_domain => 'MAP_PROVIDER',
p_sub_domain => 'MAP_PORTLET',
p_name => 'PORTLET_TITLE');

end;

Version: Oracle9iAS Portal 9.0.2 or later
Parameters:
p_domain	The domain for the message string. Example: WWS Datatype: in wwnls_strings$.domain%type
p_sub_ domain	The subdomain for the message string. Note: The default 'all' refers to the name of a specific sub-domain. 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
Returns: This function returns the base string_record. Exceptions: If this function fails to execute, NLS_EXECUTION_EXCEPTION is raised. If the message string ID is not found, an NLS_ID_NOT_FOUND_EXCEPTION is raised. Example: declare l_string_record wwnls_api.string_record; begin l_string_record := wwnls_api.get_base_string_record( p_domain => 'MAP_PROVIDER', p_sub_domain => 'MAP_PORTLET', p_name => 'PORTLET_TITLE'); end;

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