get_system_var_value function

Related topics

Contained in package wwctx_api.

Call this function to get the value of an external system variable, given its name.

This function is used during page and flow metadata generation to convert a system variable name into its value. For example, a public portlet parameter may get its value from the system variable 'USER_NAME'. During metadata generation, this variable is converted into its actual value and so the portlet can render different information on the same page, for different users.

Note: This routine always returns the same set of names, so the 'deterministic' compiler hint is used.

function get_system_var_value
(

p_system_var_name in system_var_name_type

)
return system_var_value_type deterministic;

Version: Oracle9iAS Portal 9.0.2 or later

Parameters:

p_system_var_name

The system variable name.

Valid names include all the SYSTEM_VAR_ constants, as well as any name in the set returned by get_system_var_names.

Note: Names are not case sensitive.

Datatype: in system_var_name_type

Returns:

This function returns the value of an external system variable, given its name.

Exceptions:

If the given system variable name is not recognized, SYSTEM_VAR_NAME_EXCEPTION is raised.

Example:

l_system_var_names wwctx_api.system_var_names_type;
l_system_var_name wwctx_api.system_var_name_type;
l_system_var_value wwctx_api.system_var_value_type;

l_system_var_names := wwctx_api.get_system_var_names;
for i in 1..l_system_var_names.count loop

l_system_var_name := l_system_var_names(i);
l_system_var_value := wwctx_api.get_system_var_value
(

p_system_var_name => l_system_var_name

);
...

end loop;

Version: Oracle9iAS Portal 9.0.2 or later
Parameters:
p_system_var_name	The system variable name. Valid names include all the SYSTEM_VAR_ constants, as well as any name in the set returned by get_system_var_names. Note: Names are not case sensitive. Datatype: in system_var_name_type
Returns: This function returns the value of an external system variable, given its name. Exceptions: If the given system variable name is not recognized, SYSTEM_VAR_NAME_EXCEPTION is raised. Example: l_system_var_names wwctx_api.system_var_names_type; l_system_var_name wwctx_api.system_var_name_type; l_system_var_value wwctx_api.system_var_value_type; l_system_var_names := wwctx_api.get_system_var_names; for i in 1..l_system_var_names.count loop l_system_var_name := l_system_var_names(i); l_system_var_value := wwctx_api.get_system_var_value ( p_system_var_name => l_system_var_name ); ... end loop;

Related topics
Session context API package	PDK PL/SQL API Reference - Home