NAME

cat_popfilter - Pop filter from the filter stack

SYNOPSIS

#include <cat.h>

int cat_popfilter(cat_session *session);

DESCRIPTION

Removes the topmost filter from the filter stack, calling the filter's free member function. The meaning of topmost is relative, that is, if the cat_popfilter function is called from within a filter, the filter beneath the calling filter in the filter stack will be removed.

RETURN VALUES

Returns the remaining number of filters on the stack, or a negative code if an error occurred.

NOTES

If a filter returns CAT_POP_FILTER, that filter will be removed from the filter stack.

When running in forking mode on UNIX, sessions will be closed as part of the cleanup procedure in the child process.

SEE ALSO

cat, catbuf, cat_pushfilter