3.36 getfilterinfo

Gets information about the filter. Returns the information about the filter as a hash.

Parameters:

$kiriwrite_dbmodule->getfilterinfo(options);

Usage:

$kiriwrite_dbmodule->connectfilter(); $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1, Reduced => 1 });

options
Specifies the following options as a hash in any order.

Value Description
FilterID Specifies the filter identification number to get the filter information from.
Reduced Gets a reduced version of the filter information (filter identification number, priority, filter find setting, filter replace setting and filter enabled setting).

If the filter with the filter identification number given does not exist then the error returned should be 'FilterDoesNotExist' in the $error scalar.