Table of Contents
ITGIS_AddressMatching.Match method
DK11 for ActiveX | TatukGIS_XDK11.ITGIS_AddressMatching.Match | Methods | Properties
Matches given address string and address formulas.
Syntax
// C# public int Match( WideString _str, ref ITGIS_ObjectList _results );
' VisualBasic Public Function Match( ByVal _str As WideString, ByRef _results As ITGIS_ObjectList ) As Integer
// Oxygene public function Match( _str : WideString; var _results : ITGIS_ObjectList ) : Integer;
Parameters
| Name | Type | Description |
|---|---|---|
| _str | WideString | address string |
| _results | ITGIS_ObjectList | list containing all found matches; every string is a single match in form of 'fieldld1=value1#13#10field2=value2#13#10...'; if the reference equals nil, the object will be created ; |
Result
| Type | Description |
|---|---|
| int Integer | Number of found matches (or 0 if nothing). |
Remarks
Standardizes the input string:
- removes leading and trailing spaces,
- replaces single white characters by space characters,
- replaces a group of white characters by one space character.
It uses regular expression engine for matching.
Does case-insensitive pattern matching.
If the formula is a good match, sets values for formula fields retrieving them from subexpressions.
If the retrieved value is a synonym or has synonyms, it is returned as an alternative of possible values: val1|val2|..|valN.
See the class definition to obtain information how the address formulas are built.
Found matches are returned as a list of TStrings-objects containing matches for an address formula. This is an example of returned match:
DIRPREFIX=N STREETNAME=Adams STREETTYPE=Ave
Example
This is a simple example how to use the address matching class.