All Cadcorp SIS API Methods

CombineFilter Method

Description

Creates a named Compound Filter in a Named Object Library by combining two named Filter objects using a Boolean operation, replacing any existing Filter with the same name.

Syntax

Public Function CombineFilter( _
   ByVal filterOutput As String, _
   ByVal filter1 As String, _
   ByVal filter2 As String, _
   ByVal mode As Integer _
) As Integer

Parameters

filterOutput

The named Filter to create, or replace (see Remarks).

filter1

The first Filter to combine, or an empty string (see Remarks).

filter2

The second Filter to combine, or an empty string (see Remarks).

mode

The Boolean operation to use:

SIS_BOOLEAN_AND	Items must be allowed by both Filter objects.
SIS_BOOLEAN_OR	Items must be allowed by at least one of the Filter objects.
SIS_BOOLEAN_XOR	Items must be allowed by exactly one of the Filter objects.
SIS_BOOLEAN_DIFF	Items must be allowed by filter1, but not by filter2.

Remarks

The new Compound Filter works by making and storing copies of the two old Filter objects. Any changes to the existing Filter objects after calling this method will not affect the new Compound Filter.

Either filter1 or filter2 may be empty strings (but not both). An empty string for a Filter means no Filter (i.e. no Items are excluded). By using an empty string for filter1 with the SIS_BOOLEAN_DIFF mode the effect of filter2 can be reversed.

Available: GEO D OD OM SISpy

Group:

• Filter Methods

Example

sis.CombineFilter ("Search", "Planning", "Address", SIS_BOOLEAN_AND)