pfm_$rls_cleanup Library Routine

Purpose

Releases cleanup handlers.

Syntax

#include <idl/c/base.h>
#include <idl/c/pfm.h>

void
pfm_$rls_cleanup( cleanup_record,  status)
pfm_$cleanup_rec *cleanup_record;
status_$t *status;

Description

The pfm_$rls_cleanup routine releases the cleanup handler associated with the cleanup_record parameter and all cleanup handlers established after it.

Parameters

Input

Item Description
cleanup_record Indicates the cleanup record for the first cleanup handler to release.

Output

Item Description
status Points to the completion status. If the status parameter has a value of pfm_$bad_rls_order, it means that the caller attempted to release a cleanup handler before releasing all handlers established after it. This status is only a warning. The intended cleanup handler is released, along with all cleanup handlers established after it.

Examples

To release an established cleanup handler, enter:

pfm_$rls_cleanup(crec, st);

where crec is a valid cleanup record established by the pfm_$cleanup routine.