Finds a match with user settable match preferences (properties).
Syntax
GsFunStat GsFindWithProps (GsId gs, PropList* pProps);
Arguments
gs GeoStan handle. Input.
pProps Pointer to property list structure. Input.
Return Values
GS_ADDRESS_NOT_RESOLVED GeoStan cannot resolve a match candidate.
GS_ADDRESS_NOT_FOUND GeoStan did not find an address match or if you have a metered license and the GeoStan record count is depleted.
For metered licenses, GsFind decrements the GeoStan record counter in the license each time it returns a non-error match code. If the counter reaches zero or below, GsFind returns GS_ADDRESS_NOT_FOUND and sets the match code to E015. If you have an unmetered license, no decrementing occurs, and processing is unlimited.
GS_ERROR Low-level errors; use GsErrorGet to retrieve the error information.
GS_LASTLINE_NOT_FOUND GeoStan did not find a match for city/state or ZIP Code.
GS_NOT_FOUND GeoStan did not find a match for an input PreciselyID with Reverse PreciselyID Lookup.
GS_NOT_LICENSED Missing an optional feature license.
GS_SUCCESS GeoStan found a match.
Prerequisites
GsPropListCreate()
GsPropSet*()
Notes
The application owns the property list, but GeoStan is the active user.
Do not destroy the property list while GeoStan is still using that property list.
See table GsFindWithProps properties.
Example
GsFunStat retval;
PropList findProps;
GsPropListCreate(&findProps, GS_FIND_PROP_LIST_TYPE);
GsPropSetLong(&findProps, GS_FIND_MATCH_MODE, GS_MODE_CASS);
GsPropSetLong(&findProps, GS_FIND_STREET_OFFSET, 50);
GsPropSetLong(&findProps, GS_FIND_CENTERLINE_OFFSET, 0);
GsPropSetStr (&findProps, GS_FIND_CLIENT_CRS, "NAD83");
GsPropSetBool(&findProps, GS_FIND_ADDRCODE, TRUE);
GsPropSetBool(&findProps, GS_FIND_Z_CODE, FALSE);
GsPropSetBool(&findProps, GS_FIND_FINANCE_SEARCH, TRUE);
GsPropSetBool(&findProps, GS_FIND_MIXED_CASE, TRUE);
switch(GsFindWithProps(gs, &findProps))
{
case GS_SUCCESS:
GsDataGet(gs, GS_OUTPUT, GS_ADDRLINE, address, sizeof(address));
break;
case GS_ERROR:
case GS_ADDRESS_NOT_FOUND:
case GS_ADDRESS_NOT_RESOLVED:
case GS_LASTLINE_NOT_FOUND:
default:
fprintf(stderr, "Error geocoding address.\n");
}