Generates a confidence surface type based on information from a GeoStan match.
Syntax
intl gdlGetConfidenceSurfaceType( gdlHandle hGdl, gdlConfidenceSurfType *confSurfType );
Arguments
hGdl
Identifies the gdlHandle. Input.
confSurfType
Type of confidence surface. Output.
Type options:
Type | Value | Description |
---|---|---|
GDL_SURF_UNDEFINED | 0 | Nothing has been searched yet. |
GDL_SURF_ERROR | 1 | The search failed - address was not found. |
GDL_SURF_INTERSECTION | 2 | Intersection confidence-surface generated. |
GDL_SURF_ADDRESS | 3 | Address error-surface generated. |
GDL_SURF_POINT | 4 | Point level match. |
GDL_SURF_AREA1 | 5 | State confidence-surface generated. |
GDL_SURF_AREA2 | 6 | County confidence-surface generated. |
GDL_SURF_AREA3 | 7 | City confidence-surface generated. |
GDL_SURF_AREA4 | 8 | Not used in USA. |
GDL_SURF_POSTAL1 | 9 | A Zip confidence -surface generated. |
GDL_SURF_POSTAL2 | 10 | A Zip + 2 confidence -surface generated. |
GDL_SURF_POSTAL3 | 11 | A Zip + 4 confidence -surface generated |
GDL_SURF_POSTAL4 | 12 | Not used in USA. |
Return values
GDL_OK
GDL_NOT_LICENSED
Prerequisites
gdlInitialize
gdlGenerateErrorSurface
Alternates
None.
Notes
The error (or confidence) surface type indicates the type of location that the surface encloses.
The enum definition, gdlConfidenceSurfaceType, defines the full set of possible surface types that can be generated.
In general, the better the location code from GeoStan, the higher quality the surface type.