web_add_auto_filter

Sets criteria to include or exclude URLs when downloading (applies to all subsequent action functions).

int web_add_auto_filter([Action,]< List of Attributes >, LAST );

Argument	Description
Action	A value indicating whether to include or exclude URLs matching the filter criteria. The following values are supported. – Include: include only URLs which match the criteria – Exclude: exclude URLs that match criteria. (default)
List of Attributes	For each attribute in the list, use the format `"AttributeName=value"`. For details, see the `Attributes` section, below.
LAST	A marker indicating the end of the List of Attributes

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

All attributes from the list of attributes can be parameterized using standard parameterization.

General Information

web_add_auto_filter specifies a filter to be used when downloading content for ensuing action functions. The filter is disabled when web_remove_auto_filter is invoked. Depending on the Action attribute passed in this function, the filter will either include or exclude URLs containing the matching criteria. The default action is "Action=Exclude".

If the Port attribute is set, then only content whose source is that port is downloaded. If no port is specified, then all ports are considered a match.

Attributes

URL – the specific URL to filter

UrlPrefix – Filter all URLs that begin with this string. For example,

"UrlPrefix = http://www.cc"

filters http://www.ccn.com, http://www.cc.edu, http://cc–nanochem.de, and any other URL that begins with "http://www.cc"

Host – URLs which include Host in the hostname portion of the URL path are filtered

HostPrefix – URLs which include this prefix in the hostname portion of the URL path are filtered

HostSuffix – URLs which include this suffix in the host name portion of the URL path are filtered

Path – URLs with the specified path are filtered

PathPrefix – URLs with the specified path prefix are filtered

PathSuffix – URLs with the specified path suffix are filtered

Port – URLs from the specified port are filtered

Scheme – URLs with the specified communications scheme are filtered. Example schemes are http, https and ftp

Query – URLs with the specified query are filtered

QueryPrefix – URLs with the specified query prefix are filtered

QuerySuffix – URLs with the specified query suffix are filtered

FragmentId – URLs containing a matching Fragment ID are filtered

FragmentIdPrefix – URLs containing a matching Fragment ID prefix are filtered

FragmentIdSuffix – URLs containing a matching Fragment ID suffix are filtered

ID: An identifier for use by web_remove_auto_filter.

Example

The following example uses web_add_auto_filter to exclude URLs with a path prefix of /Images/Upload. The call applies to all subsequent action functions.