All Cadcorp SIS API Methods

GetFeatureFilterBranches Method

Description

Gets the feature codes branching from a parent feature code in a named Feature Filter

Syntax

Visual Basic
Public Function GetFeatureFilterBranches( _
   ByVal filter As String, _
   ByVal fcode As Long _
) As String

Parameters

filter
The named Feature Filter to query.
 
fcode
The feature code whose children are to be queried, from 0 to 65535. Use 0 to query the top-level feature codes.

Return Type

A space-separated string of the following format: "nCodes code1 code2 ... codeN". The first item in the returned string is the number of feature codes in the string.

Remarks

Predefined filters are prefixed by their type:

Prefix Description Example
Class Filter.   class-based filters  'Class Filter.Area'
Compound Filter. two filters added together   'Compound Filter.(Default)'
Feature Filter. filters based on feature codes  'Feature Filter.Land-Line'
Property Filter.  filters based on properties  'Property Filter.Closed'

Available: GEO D OD OM OV SISpy

Groups:

Example

sis.FeatureFilterBranches ("Feature Filter.Land-Line", 10102)

Returns a string containing the child feature codes "3 1 4 1006", of the feature code 10102.