get_login_link function

Related topics

Contained in package wwsec_app_priv.

Call this function to provide applications with a hyperlink to the user Login Page. Use this function to render a link to the user Login Page.

Notes:

The function returns a string containing anchor tags and a hyperlink reference to the URL.

The second option allows the link text to be set by the application, or it can use the default as described below.

function get_login_link

(

p_nls_link_text in varchar2 default null,

p_image_filename in varchar2 default null,

p_requested_url in varchar2 default wwctx_api.get_product_schema || '.home'

)

return varchar2;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_nls_link_text

Optional text that is used as the hyperlink text if the format CONTENT_TYPE_HTML is specified.

Note: This text should be in the NLS language requested by the user.

Datatype: in varchar2
Default: null

p_image_filename

An optional image filename and path for inclusion in an image tag to use with the Login link.

The default (null) results in a simple text link.

Note: When this parameter is specified, the nls_link_text is used as alternative (mouseover) text, i.e. Alt text.

Datatype: in varchar2
Default: null

p_requested_url

An optional parameter indicating the URL that you want to be redirected to upon successful authentication.

Note: This parameter allows an application to specify a page to be redirected to upon successful authentication.

Datatype: in varchar2
Default: wwctx_api.get_product_schema || '.home'

Returns:

This function returns anchor tags and a hyperlink reference to the URL.

Exceptions:

This function raises no exceptions. If an error occurs, it returns null.

Example:

htp.htmlopen;

htp.bodyopen;

htp.p

(

wwsec_app_privs.get_login_link

(

p_nls_link_text => wwnls_api.get_string

(

p_domain => 'research',

p_sub_domain => 'main',

p_language => 'us',

p_name => 'login_link_text',

)

p_image_filename => wwctx_api.get_image_path('login.gif'),

p_requested_url => wwctx_api.get_product_schema || '.home'

)

);

htp.bodyclose;

htp.htmlclose;

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_nls_link_text	Optional text that is used as the hyperlink text if the format CONTENT_TYPE_HTML is specified. Note: This text should be in the NLS language requested by the user. Datatype: in varchar2 Default: null
p_image_filename	An optional image filename and path for inclusion in an image tag to use with the Login link. The default (null) results in a simple text link. Note: When this parameter is specified, the nls_link_text is used as alternative (mouseover) text, i.e. Alt text. Datatype: in varchar2 Default: null
p_requested_url	An optional parameter indicating the URL that you want to be redirected to upon successful authentication. Note: This parameter allows an application to specify a page to be redirected to upon successful authentication. Datatype: in varchar2 Default: wwctx_api.get_product_schema \|\| '.home'
Returns: This function returns anchor tags and a hyperlink reference to the URL. Exceptions: This function raises no exceptions. If an error occurs, it returns null. Example: htp.htmlopen; htp.bodyopen; htp.p ( wwsec_app_privs.get_login_link ( p_nls_link_text => wwnls_api.get_string ( p_domain => 'research', p_sub_domain => 'main', p_language => 'us', p_name => 'login_link_text', ) p_image_filename => wwctx_api.get_image_path('login.gif'), p_requested_url => wwctx_api.get_product_schema \|\| '.home' ) ); htp.bodyclose; htp.htmlclose;

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