get_direct_doc_path function

Related topics

Contained in package wwctx_api.

Returns the path to a file stored in the Oracle Portal repository.

If no path name is provided, the function returns the Oracle Portal repository path (during installation this defaults to /docs).

Use this function to construct URLs to documents stored in wwdoc_document$. For example, if the filename specified is '123.GIF' the function returns a path such as 'docs/1/123.GIF'.

The primary use of this function is to retrieve image documents. It does not retrieve the direct access URL that is needed for documents such as HTML files, which may have relative URLs in the file itself, e.g. docs/page/A/B/C/MYPAGE.HTML.

function get_direct_doc_path

(

p_name in varchar2 default null

)

return varchar2;

Version: Oracle9iAS Portal 9.0.2 or later

Parameters:

p_name

The name of a file stored in the Oracle Portal repository.

The name of the file must be of the format NNNNN.EXT, where NNNNN is a number (such as 123) and EXT is the extension of the file. For example, 123.GIF.

Note: Do not specify a document filename (such as LOGO.GIF). Use the name of the document as stored in Oracle Portal.

Datatype: in varchar2
Default: null

Returns:

This function returns the path to a file stored in the Oracle Portal repository.

Exceptions:

This function raises no user-defined exceptions.

Example:

wwctx_api.get_direct_doc_path

(

p_name => '123.GIF'

);

Version: Oracle9iAS Portal 9.0.2 or later
Parameters:
p_name	The name of a file stored in the Oracle Portal repository. The name of the file must be of the format NNNNN.EXT, where NNNNN is a number (such as 123) and EXT is the extension of the file. For example, 123.GIF. Note: Do not specify a document filename (such as LOGO.GIF). Use the name of the document as stored in Oracle Portal. Datatype: in varchar2 Default: null
Returns: This function returns the path to a file stored in the Oracle Portal repository. Exceptions: This function raises no user-defined exceptions. Example: wwctx_api.get_direct_doc_path ( p_name => '123.GIF' );

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