GsFindWithProps properties
Find Boolean Type properties have a default value of False when the property is not in the find property list, except for GS_FIND_MUST_MATCH_ADDRNUM.
Conflicting API functions
Detailed here are the categories and categories that conflict in the GsFindWithProps properties listed below.
GeoStan applications control the behavior of GsFindWithProps by setting any of the find properties. You can find the complete list of these find properties in table GsFindWithProps properties. These properties naturally fall into several categories. Rules exist that control which categories of properties can intermix. The tables below show which property categories conflict. Those categories that are not shown to be in conflict can be used together.
GeoStan detects conflicting properties and returns appropriate error messages from the several GsPropSet* functions. This prevents illegal, inconsistent, conflicting, or confusing property combinations from occurring. By guaranteeing fully consistent property lists, this allows the GeoStan engine code to have a clear path to perform the matching logic.
By clearly defining the categories into which the properties fall, and which categories of properties are for use together, this aids in familiarizing you in the semantics and capabilities of the properties. The categories are described below:
Category |
Description |
---|---|
Any |
No restrictions on the use of this property with other properties. In other words, a property in this category can be used in combination with other properties from a similar property type (init, status, or find). |
AnyForward |
Find properties that are usable with any use of GsFindWithProps which is doing "forward geocoding", that is, standardizing and geocoding an input address. |
GeoStanReverse |
Find properties that are usable with any use of GsFindWithProps which is doing a reverse geocoding search. |
GeoStanFindFirstStreet |
Find properties that are usable with any use of GsFindWithProps which is doing an FindFirstStreet/Segment/Range search. |
Custom |
Find properties that are usable with any use of GsFindWithProps which is using custom find properties. |
The properties with the categories listed below in the Category column cannot be used with the properties with categories listed in the Conflicting Category column.
Category |
Conflicting category |
---|---|
Any |
None. |
AnyForward |
GeoStanReverse GeoStanFindFirstStreet |
GeoStanReverse |
GeoStanFindFirstStreet Custom AnyForward |
GeoStanFindFirstStreet |
Custom AnyForward GeoStanReverse |
Custom |
GeoStanReverse GeoStanFindFirstStreet |
GeoStan does not allow an application to add a property from the category listed in the Category column, if the property list already contains a MatchMode property type listed in the MatchMode value column below:
Category |
MatchMode value |
---|---|
Custom |
Relax Interactive Close Exact |
GeoStanReverse GeoStanFindFirstStreet |
Custom |
GeoStan does not allow an application to change the MatchMode value to those listed in the MatchMode value column, if the property list already contains at least on property from any of the categories listed in the Category column below:
MatchMode value |
Property |
---|---|
Relax Interactive Close Exact Custom |
Custom |
Custom |
AnyForward GeoStanReverse GeoStanFindFirstStreet |
CASS |
BuildingSearch PreferStreet PreferPOBox AddressRange StreetCentroid Any MustMatch* property |
When the MatchMode is already set to CASS, none of the properties listed in the Property column can be set. Similarly, if any of the properties in the Property column are already in the property list, the MatchMode cannot be set to CASS.
This early property conflict detection feature prevents the conflicts described in this section from occurring.
Properties formerly set with GsFind:
GS_FIND_ADDRCODE
Type |
Boolean |
Description |
Attempts to standardize and find an address geocode. Set this switch if you want the address parsed and standardized. If this switch is not set, GeoStan uses only the input ZIP and ZIP + 4 address elements. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_ADDR_CODE. |
GS_FIND_WIDE_SEARCH
Type |
Boolean |
Description |
Considers all records matching the first letter of the street name, rather than the soundex key on the street name, which allows a wider search. This option has no effect when performing a ZIP centroid match. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any, Custom, GeoStanReverse and GeoStanFindFirstStreet. Conflicts with: none. |
Usable match modes |
Relax, Interactive, Close, and Exact. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_WIDE_SEARCH. |
GS_FIND_SEARCH_AREA
Type |
Long |
Description |
Assists in finding a match when the input address contains limited or inaccurate city or ZIP Code information. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: Any, AnyForward, GeoStanReverse and GeoStanFindFirstStreet. Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. Search area cannot be changed in CASS match mode. |
Values |
0 - GS_FIND_SEARCH_AREA_CITY - Searches the specified city. 1 - GS_FIND_SEARCH_AREA_FINANCE - Searches the entire Finance Area for possible streets. This option has no effect when performing a ZIP centroid match. 2 - GS_FIND_SEARCH_AREA_EXPANDED - This value effectively has two options that can be set: Allows the setting of the radius in miles (up to 99) around which your record lies. The default radius setting is 25 miles. Allows for limiting the search to the state. The default setting is True. For more information see Search area designation. |
Default value |
0 |
Relation to deprecated feature |
Overrides GS_FINANCE_SEARCH and GS_FIND_EXPANDED_SEARCH. |
GS_FIND_BUILDING_SEARCH
Type |
Boolean |
Description |
Controls the ability to search by building name entered in the address line. Enables matching to building names even when no unit numbers are present. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_BUILDING_SEARCH. |
GS_FIND_CENTERLN_PROJ_OF_POINT
Type |
Boolean |
Description |
Enables GeoStan to keep multiple candidate records when matching with point-level data for use with centerline matching. Not valid when using the reverse geocoding options. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_ALWAYS_FIND_CANDIDATES. |
GS_FIND_Z9_CODE
Type |
Boolean |
Description |
Attempts to find a ZIP + 4 centroid match only. Not valid when using the reverse geocoding options. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForwardand Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_Z9_CODE. |
GS_FIND_Z7_CODE
Type |
Boolean |
Description |
Attempts to find a ZIP+2 centroid match only (no ZIP + 4 or ZIP). Not valid when using the reverse geocoding options. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_Z7_CODE. |
GS_FIND_Z5_CODE
Type |
Boolean |
Description |
Attempts to find a ZIP centroid match (no ZIP + 4 or ZIP+2). Not valid when using the reverse geocoding options. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_Z5_CODE. |
GS_FIND_Z_CODE
Type |
Boolean |
Description |
Attempts to find any ZIP centroid match. Not valid when using the reverse geocoding options. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_Z_CODE. |
GS_FIND_PREFER_POBOX
Type |
Boolean |
Description |
Sets the preference to P.O. Box addresses instead of street addresses for multi-line input addresses. See "Specifying a preference for street name or P.O. Box" on page 36 for more information. Ignored if processing in CASS mode. If both GS_FIND_PREFER_POBOX and GS_FIND_PREFERSTREET are set to True, then they are ignored and the default, GS_FIND_PREFER_STREET is used. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_PREFER_POBOX. |
GS_FIND_PREFER_STREET
Type |
Boolean |
Description |
Sets the preference to street addresses instead of P.O. Box addresses for multi-line input addresses. Ignored if processing in CASS mode. If both GS_FIND_PREFER_POBOX and GS_FIND_PREFERSTREET are set to True, then they are ignored and the default, GS_FIND_PREFER_STREET is used. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse, GeoStanFindFirstStreet and Custom. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_PREFER_STREET. |
GS_FIND_NEAREST_ADDRESS
Type |
Boolean |
Description |
Specifies that GeoStan can match to addresses interpolated on street segments or to point data locations. You can use GS_FIND_NEAREST_ADDRESS and GS_FIND_NEAREST_INTERSECTION together to specify reverse geocoding to both addresses and intersections. For reverse geocoding, you need to set the reverse geocoding processing find properties: GS_FIND_NEAREST_ADDRESS, GS_FIND_NEAREST_INTERSECTION, and/or GS_FIND_NEAREST_UNRANGED. The address processing and multi-line address processing options are not valid for reverse geocoding. |
Category |
GeoStanReverse |
Usage with other properties in other categories. |
Compatible with: Reverse and Any. Conflicts with: GeoStanFindFirstStreet, Custom, AnyForward |
Usable match modes |
Reverse geocoding doesn’t use match modes - valid for all match modes. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_NEAREST_ADDRESS. |
GS_FIND_NEAREST_INTERSECTION
Type |
Boolean |
Description |
Specifies that GeoStan can match to intersections. You can use GS_FIND_NEAREST_INTERSECTION and GS_FIND_NEAREST_ADDRESS together to specify reverse geocoding to both addresses and intersections. For reverse geocoding, you need to set the reverse geocoding processing find properties: GS_FIND_NEAREST_INTERSECTION, GS_FIND_NEAREST_ADDRESS, and/or GS_FIND_NEAREST_UNRANGED. The address processing and multi-line address processing options are not valid for reverse geocoding. |
Category |
GeoStanReverse |
Usage with other properties in other categories. |
Compatible with: Reverse and Any. Conflicts with: GeoStanFindFirstStreet, Custom, AnyForward |
Usable match modes |
Reverse geocoding doesn’t use match modes - valid for all match modes. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_NEAREST_INTERSECTION. |
GS_FIND_NEAREST_UNRANGED
Type |
Boolean |
Description |
Specifies that GeoStan can match a street segment with no number ranges. Enabled with GS_FIND_NEAREST_ADDRESS. Ignored for point data and intersection matches. |
Category |
GeoStanReverse |
Usage with other properties in other categories. |
Compatible with: Reverse and Any. Conflicts with: GeoStanFindFirstStreet, Custom, AnyForward |
Usable match modes |
Reverse geocoding doesn’t use match modes - valid for all match modes. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides GS_NEAREST_UNRANGED. |
Properties formerly set with GsDataSet:
GS_FIND_SEARCH_DIST
Type |
Long |
Description |
Radius, in feet, that GeoStan searches for a reverse geocode match. The range is 0 - 5280 feet. Note: GS_FIND_SEARCH_DIST is also used for the Predictive Lastline and PreciselyID Fallback features in forward geocoding. |
Category |
GeoStanReverse |
Usage with other properties in other categories. |
Compatible with: GeoStanReverse and Any. Conflicts with: GeoStanFindFirstStreet, and AnyForward (see the note above for the exceptions for use in forward geocoding). |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
Any positive integer, which represents number of feet |
Default value |
150 feet. |
Relation to deprecated feature |
Overrides enum value, GS_SEARCH_DIST. |
GS_FIND_STREET_OFFSET
Type |
Long |
Description |
Left and right offset distance from the street segments. The range is 0 - 999 feet. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet.. Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
Any positive integer, which represents number of feet |
Default value |
50 |
Relation to deprecated feature |
Overrides enum value, GS_OFFSET_DIST. |
GS_FIND_CENTERLINE_OFFSET
Type |
Long |
Description |
Offset distance from the street center for a centerline match. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Exact, Close, CASS, Relax, Interactive and Custom. |
Values |
Any positive integer, which represents number of feet. |
Default value |
0 feet. |
Relation to deprecated feature |
Overrides enum value, GS_CENTERLINE_OFFSET. |
GS_FIND_CORNER_OFFSET
Type |
Long |
Description |
Distance, in feet, to offset address-level geocodes from the street end points. If the corner offset distance is more than half the segment length, GeoStan sets the distance to the midpoint of the segment. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
Any positive integer, which represents number of feet. |
Default value |
50 |
Relation to deprecated feature |
Overrides enum value, GS_SQUEEZE_DIST. |
Properties formerly set with their own individual API functions:
GS_FIND_CLIENT_CRS
Type |
String |
Description |
Coordinate Reference System. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
NAD27 and NAD83. |
Default value |
NAD83. |
Relation to deprecated feature |
Overrides functions GsSetDatum and GsGetDatum. |
GS_FIND_MATCH_MODE
Type |
Long |
Description |
Controls the closeness-of-match rules used for matching in GsFindWithProps. This property affects how GsDataSet performs, specifically how the input address is parsed. For this reason, only alter this find property before calling GsDataSet to input the address and lastline data. If you alter this property after calling GsDataSet, the results of the subsequent find will be unpredictable. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward and Any. Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. In reverse geocoding, this setting is ignored. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
GS_MODE_EXACT: Requires an exact name match. Generates the fewest number of possibles to search. GS_MODE_CLOSE: Requires a very close name match. Generates a moderate number of possibles to search GS_MODE_RELAX: Requires a close name match. Generates a large number of possibles to search. GS_MODE_INTERACTIVE: For singleline address matching only. Allows for more flexible matching patterns and may, in some cases, return additional possible matches than Relax match mode. GS_MODE_CASS: Requires a close name match. Generates a modest number of possibles to search. This setting imposes additional rules to ensure compliance with the USPS regulations for CASS software. For example, this mode disables intersection matching, and matching to the User Dictionary matches for standardization GS_MODE_CUSTOM: Allows applications to specify individual "must match" field matching rules for address number, address line, city, ZIP Code, state. Note: Not supported in singleline address matching. |
Default value |
GS_MODE_CLOSE |
Relation to deprecated feature |
Overrides function GsSetMatchMode(). |
GS_FIND_MIXED_CASE
Type |
Boolean |
Description |
Returns results in mixed case. |
Category |
Any |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. Conflicts with: none. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides function GsSetMixedCase. |
GS_FIND_STREET_CENTROID
Type |
Boolean |
Description |
Turns on street locator geocoding. |
Category |
AnyForward |
Usage with other properties in other categories. |
Compatible with: AnyForward, Any. Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet.. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides function GsSetStreetCentroid. |
Custom properties:
GS_FIND_MUST_MATCH_ADDRNUM
Type |
Boolean |
Description |
Candidates must match house number exactly. |
Category |
Custom |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Custom |
Values |
True or False |
Default value |
True |
Relation to deprecated feature |
None |
GS_FIND_MUST_MATCH_CITY
Type |
Boolean |
Description |
Candidates must match city. |
Category |
Custom |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Custom |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_MUST_MATCH_MAINADDR
Type |
Boolean |
Description |
Candidates must match main address exactly. |
Category |
Custom |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Custom |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_MUST_MATCH_STATE
Type |
Boolean |
Description |
Candidates must match state. |
Category |
Custom |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Custom |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_MUST_MATCH_ZIPCODE
Type |
Boolean |
Description |
Candidates must match ZIP Code. |
Category |
Custom |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Custom |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
Properties exclusive to GsFindFirstStreet
GS_FIND_CITY_SEARCH
Type |
Boolean |
Description |
GeoStan searches the city and state specified by pLocale. |
Category |
GeoStanFindFirstStreet |
Usage with other properties in other categories. |
•Compatible with: GeoStanFindFirstStreet and Any. •Conflicts with:Custom, AnyForward, and GeoStanReverse. |
Usable match modes |
Relax, Interactive, Close, and Exact. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides enum GS_CITY_SEARCH. |
GS_FIND_EXTRA_SEARCH
Type |
Boolean |
Description |
GeoStan searches the primary street files, Use.gsd and Usw.gsd, and the supplemental street files, Ustw.gsd and Uste.gsd, for streets without house numbers. If you specify this option, pNumber must be blank. If you specify pNumber, GeoStan searches only the primary street files, Usw.gsd and Use.gsd, which contain addressed segments. Assign the directory for this file to the pGeoPaths member of GsInitStruct when calling GsInitWithProps. Note: MVS customers receive one primary street file, Us.gsd, and one supplemental street file, Ust.gsd. |
Category |
GeoStanFindFirstStreet |
Usage with other properties in other categories. |
•Compatible with: GeoStanFind, GeoStanFindFirstStreet, and Any. •Conflicts with:Custom, AnyForward, and GeoStanReverse. |
Usable match modes |
Relax, Interactive, Close, and Exact. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides enum GS_EXTRA_SEARCH. |
GS_FIND_SDX_SEARCH
Type |
Boolean |
Description |
GeoStan searches by soundex. pName is a pointer to a numeric soundex key returned by GsSoundex. If you do not specify this option, GeoStan assumes that pName is a street name. |
Category |
GeoStanFindFirstStreet |
Usage with other properties in other categories. |
•Compatible with: GeoStanFindFirstStreet and Any. •Conflicts with:Custom, AnyForward, and GeoStanReverse. |
Usable match modes |
Relax, Interactive, Close, and Exact. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides enum GS_SDX_SEARCH. |
GS_FIND_ZIP_SEARCH
Type |
Boolean |
Description |
GeoStan searches the ZIP Code specified by pLocale. When this option is set with GsFindFirstStreet, GeoStan performs a finance search. |
Category |
GeoStanFindFirstStreet |
Usage with other properties in other categories. |
•Compatible with: GeoStanFindFirstStreet and Any. •Conflicts with:Custom, AnyForward, and GeoStanReverse. |
Usable match modes |
Relax, Interactive, Close, and Exact. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
Overrides enum GS_ZIP_SEARCH. |
Additional GeoStan Find properties
GS_FIND_ADDRESS_RANGE
Type |
Boolean |
Description |
Enables Map Marker address range geocoding compatibility. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, and Custom. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_ADDRPOINT_INTERP
Type |
Boolean |
Description |
Enables address point interpolation. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_ALTERNATE_LOOKUP
Type |
Long |
Description |
Determines whether the preferred lookup is to look for the streets first or the firms first. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
•1 - GS_PREFER_STREET_LOOKUP - Matches to the address line, if a match is not made, then GeoStan matches to the Firm name line. •2 - GS_PREFER_FIRM_LOOKUP - Matches to the Firm name line, if a match is not made, then GeoStan matches to address line. •3 - GS_STREET_LOOKUP_ONLY (default) - Matches to the address line. |
Default value |
3 |
Relation to deprecated feature |
None |
GS_FIND_APPROXIMATE_PBKEY
Type |
Boolean |
Description |
When using the Master Location Dataset (MLD), when a match is not made to an MLD record, this feature returns the GS_PB_KEY of the nearest MLD point location. The search radius for the nearest MLD point location can be configured to 0-5280 feet. The default is 150 feet. This type of match returns a GS_PB_KEY with a leading ‘X’ rather than a ‘P’, for example, X00001XSF1IF. The GS_INIT_OPTIONS_SPATIAL_QUERY init property must be set to True to enable this feature. For more information, see PreciselyID Fallback. |
Category |
AnyForward, GeoStanReverse |
Usage with other properties in other categories.
|
•Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. •Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_CLOSEST_POINT
Type |
Boolean |
Description |
For reverse geocoding, enables matching to the nearest point address within the search radius, rather than to the closest feature (e.g. street segment or intersection as well as point addresses). Note: Requires that at least one streets data set and one points data set are loaded; otherwise, the match will be made to the closest feature. |
Category |
GeoStanReverse |
Usage with other properties in other categories. |
Compatible with: Reverse and Any. Conflicts with: GeoStanFindFirstStreet, Custom, AnyForward |
Usable match modes |
Match mode has no impact on reverse geocoding. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_CORRECT_LASTLINE
Type |
Boolean |
Description |
Corrects the output last line. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_DB_ORDER
Type |
String |
Description |
List of database index values [starting at 0, separated by semi-colons] indicating which to search and in what order. See also the related functions GsGetNumDB() and GsGetDBMetadata, and GS_MATCHED_DB. If this property is not set, the behavior is to search the DBs in the following order: –Aux files –UDs of all types (street and point) –Point files (Master Location Data, TomTom Points and HERE Points) –GSD (TomTom and HERE) –GSD (TIGER) –GSD (USPS) |
Category |
Any |
Usage with other properties in other categories.
|
•Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. •Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
Empty string. |
Default value |
Varies according to the priority list in the Description field above. |
Relation to deprecated feature |
None |
GS_FIND_DPV
Type |
Boolean |
Description |
Turn on DPV mode. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward, Any, Custom •Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
True |
Relation to deprecated feature |
None |
GS_FIND_EXPANDED_SEARCH_RADIUS
Type |
Long |
Description |
Distance, in feet, to use for the expanded search radius. |
Category |
Any |
Usage with other properties in other categories. |
•Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. •Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
Any positive number. |
Default value |
132000 |
Relation to deprecated feature |
None |
GS_FIND_EXPND_SRCH_LIM_TO_STATE
Type |
Boolean |
Description |
Do not cross state boundaries when doing an expanded search. |
Category |
Any |
Usage with other properties in other categories. |
•Compatible with: AnyForward, Any, Custom, GeoStanReverse, and GeoStanFindFirstStreet. •Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, and Custom. |
Values |
True or False |
Default value |
True |
Relation to deprecated feature |
None |
GS_FIND_FIRST_LETTER_EXPANDED
Type |
Boolean |
Description |
Enables extra processing for bad first letter (missing, wrong, etc.). |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Custom, and CASS. Ignored in Exact mode. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_LACSLINK
Type |
Boolean |
Description |
Turns on LACSLink mode. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
True |
Relation to deprecated feature |
None |
GS_FIND_MATCH_CODE_EXTENDED
Type |
Boolean |
Description |
Enables the return of additional address match information. Most notably, this is used to indicate whether or not an exact match was made to the input unit number. An address match is still returned if there is not an exact match to the input unit number, but the match is to the main building address without units. This extended match code digit will also provide information about any changes in the house number, unit number and unit type fields. In addition, it can indicate whether there was address information that was ignored. For more information, see Understanding Extended Match Codes. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward, Any, Custom. •Conflicts with: None. |
Usable match modes |
Relax, Interactive, Close, Exact, Custom, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_POINT_ZIP_MATCH
Type |
Boolean |
Description |
Enables point ZIP matching. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward andAny. •Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_PREFER_ZIP_OVER_CITY
Type |
Boolean |
Description |
Prefer candidates matching input ZIP over matches to input city. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Close, Exact, and Custom. Ignored for Interactive and CASS match modes. Interactive match mode returns the best address regardless of this setting. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_RET_INTERSECTION_NUM
Type |
Boolean |
Description |
Returns intersection numbers. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward and Any. •Conflicts with: GeoStanReverse and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Exact, and CASS. |
Values |
True or False |
Default value |
False |
Relation to deprecated feature |
None |
GS_FIND_SUITELINK
Type |
Boolean |
Description |
Enables SuiteLink mode. |
Category |
AnyForward |
Usage with other properties in other categories. |
•Compatible with: AnyForward, and Any. •Conflicts with: GeoStanReverse, and GeoStanFindFirstStreet. |
Usable match modes |
Relax, Interactive, Close, Custom and CASS. Exact match mode ignores this setting. |
Values |
True or False |
Default value |
True |
Relation to deprecated feature |
None |