stop_log procedure

Related topics

Contained in package wwlog_api.

Call this procedure to end a logging event that was started by wwlog_api.start_log.

Notes:

If the log was started with p_deferred set to TRUE (in start_log), then the stop_log call creates a record in the log table.

If p_deferred was set to FALSE, then the record exists and is updated with the elapsed time, i.e. from the time the start_log function was called to the time the stop_log function is called.

procedure stop_log

(

p_id in integer,

p_row_count in integer default 0,

p_deferred in boolean default true

);

Any user can use the stop_log procedure.

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_id

A unique identifier for the logged event.

Datatype: integer

p_row_count

Returns the number of table rows acted upon, or retrieved by the stop_log call.

Datatype: in integer
Default: 0

p_deferred

Indicates whether the database record should be created or updated by the stop_log call.

If p_deferred is TRUE, the log event is recorded when the matching stop call is received.
If p_deferred is FALSE, then the log record already exists and will be updated with the elapsed time since the log was started.

Note: The wwlog_api.stop_log command should be called with the same p_deferred value as its corresponding wwlog_api.start_log command.

Datatype: boolean
Default: TRUE

Exceptions:

If the log cannot be purged, an UNABLE_TO_PURGE_LOG_EXCEPTION is raised.

If a temporary log record cannot be updated, a CANNOT_UPDATE_LOG_EXCEPTION is raised.

If a log record cannot be inserted into database, a CANNOT_INSERT_LOG_EXCEPTION is raised.

Example:

wwlog_api.stop_log

(

p_id => l_logid,

p_row_count => 34,

p_deferred => true

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_id	A unique identifier for the logged event. Datatype: integer
p_row_count	Returns the number of table rows acted upon, or retrieved by the stop_log call. Datatype: in integer Default: 0
p_deferred	Indicates whether the database record should be created or updated by the stop_log call. If p_deferred is TRUE, the log event is recorded when the matching stop call is received. If p_deferred is FALSE, then the log record already exists and will be updated with the elapsed time since the log was started. Note: The wwlog_api.stop_log command should be called with the same p_deferred value as its corresponding wwlog_api.start_log command. Datatype: boolean Default: TRUE
Exceptions: If the log cannot be purged, an UNABLE_TO_PURGE_LOG_EXCEPTION is raised. If a temporary log record cannot be updated, a CANNOT_UPDATE_LOG_EXCEPTION is raised. If a log record cannot be inserted into database, a CANNOT_INSERT_LOG_EXCEPTION is raised. Example: wwlog_api.stop_log ( p_id => l_logid, p_row_count => 34, p_deferred => true );

Related topics
Event logging API package	PDK PL/SQL API Reference - Home