Allows GeoStan to use a record found outside of GsFind as a match.
Syntax
GsFunStat GsSetSelectionRange(GsId gs, GsRangeHandle *pRange,GsEnum
options);
Arguments
GsIdgs ID returned by GsInitWithProps() for the current instance of GeoStan. Input.
GsRangeHandle*pRange Range pointer of the object to return as a match. A range record indicates a range of addresses such as "2800 - 2900 Center Green Drive". Input.
GsEnumoptions GsSetSelectionRange options. The following table contains the valid enums. Input.
|
GS_ADDR_CODE |
Attempts to standardize and find an address geocode. You must set this switch for address standardization. If this switch is not set, GeoStan uses only the input ZIP and ZIP + 4 address elements. |
|
GS_WIDE_SEARCH |
GeoStan considers all records matching the first letter of the street name, rather than the soundex key on the street name. This results in a wider search. |
|
GS_FINANCE_SEARCH |
When you add GS_FINANCE_SEARCH, GeoStan searches the entire Finance Area for possible streets. These modifiers have no meaning when doing a ZIP centroid match. |
|
GS_Z9_CODE |
Attempts to find ZIP + 4 centroid match only (no ZIP+2 or ZIP). |
|
GS_Z7_CODE |
Attempts to find ZIP+2 centroid match only (no ZIP + 4 or ZIP). |
|
GS_Z5_CODE |
Attempts to find a ZIP centroid match (no ZIP + 4 or ZIP+2). |
|
GS_Z_CODE |
Attempts to find a match based on all possible ZIP centroids available. |
If you specify GS_ADDR_CODE and a ZIP centroid option, GeoStan only returns a ZIP Code centroid match if an address geocode is not available.
You must use either GS_ADDR_CODE or GS_Z_CODE or both.(In general, you should specify both.) These option settings are additive.
If you enter a pre-parsed address, it must contain the USPS abbreviations for street type, predirectionals, and postdirectionals.
Return Values
GS_SUCCESS
GS_ERROR
Prerequisites
GsFindFirstRange()
Notes
This function allows you to get a range handle that points to the address range to which you want to match. Use this command to indicate that GsFindWithProps() found the match, when in fact the match is set to whichever range handle is passed through the *pRange argument. You must specify the options enum so that subsequent calls to GsDataGet() have the type of location information to return.
This function returns standardized results from a list generated by GsFindFirst/GsFindNext. Use this function to perform a query that lets the user choose from a list of possible matches.