Oracle9iAS Portal Developer Kit

remove_string function (domain, subdomain, name, language)

Contained in package wwnls_api.

Call this function to remove a single translation of a string, or all translations of a string.

Note: If p_sub_domain is not specified, then a value of 'all' is assumed. Here, 'all' is the name of a single subdomain. It does not refer to all subdomains.

function remove_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,

p_remove_all in boolean default false

)

return number;

If a base string is deleted, all translations for the specified string are deleted.

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$.sub_domain%type
Default: 'all'

p_name

The unique name for the message string.

Datatype: in wwnls_strings$.name%type

p_language

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

Example: wwnls_api.BULGARIAN

Datatype: in wwnls_strings$.language%type

p_remove_all

Indicates if all translations of a string should be removed:

  • TRUE removes all strings of the specified language.

  • FALSE removes only the specified string.

Datatype: in boolean
Default: false

Returns:

This function returns the number of rows deleted.

Exceptions:

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

Example:

l_number := wwnls_api.remove_string

(

p_domain => 'IPORTAL',

p_sub_domain => 'ALL',

p_name => 'TEST',

p_language => wwnls_api.BULGARIAN,

p_remove_all => TRUE

);

Related topics

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