| get_string function (domain, subdomain, name, language)

Related topics
Contained in package wwnls_api. Call this function to return an NLS string based on domain, subdomain, name, and language. function get_string ( 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, p0 in varchar2 default null, p1 in varchar2 default null, p2 in varchar2 default null, p3 in varchar2 default null, p4 in varchar2 default null, p5 in varchar2 default null, p6 in varchar2 default null, p7 in varchar2 default null, p8 in varchar2 default null, p9 in varchar2 default null ) return varchar2;

Version: Oracle Portal 3.0.6.6.5 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
p_language | The NLS language name constant for the language to be returned. Example: wwnls_api.AMERICAN Datatype: in wwnls_strings$.language%type
(p0, p1, ... p9) | Values used for parameter substitution. Notes: These are optional run-time values that may be inserted into the message string. The message string must contain the markup characters %0, %1, through %9 in order to pass in the appropriate parameter value. Only the specified non-null values p0 through p9 are used for substitution. Extra values are ignored. Only non-null values are used for substitution. Datatype: in varchar2 Default: null
Returns: If the translation specified in p_language is found, this function returns a string based on domain, subdomain, string name, and language name. If the translation specified in p_language is not found, this function returns the base string. Exceptions: If this function fails to execute, an NLS_EXECUTION_EXCEPTION is raised. Example: declare l_string_id integer; l_string varchar2(200); begin l_string := wwnls_api.get_string( p_domain => 'MAP_PROVIDER', p_sub_domain => 'MAP_PORTLET', p_name => 'PORTLET_TITLE', p_language => wwnls_api.AMERICAN); -- no translation in Hebrew, string returned in English l_string := wwnls_api.get_string( p_domain => 'MAP_PROVIDER', p_sub_domain => 'MAP_PORTLET', p_name => 'PORTLET_TITLE', p_language => wwnls_api.AMERICAN); -- string returned in French end;

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

Back to top
The PL/SQL API Reference is part of the Portal Developer Kit on Portal Studio