GDLCST - geographicdeterminationlibrary - 2024.00

Geographic Determination Library Reference for Windows and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Geographic Determination Library
Version
2024.00
Language
English
Product name
GeoStan Geocoding Suite
Title
Geographic Determination Library Reference for Windows and z/OS
Topic type
Reference
Copyright
2024
First publish date
1994
ft:lastEdition
2024-05-09
ft:lastPublication
2024-05-09T00:55:21.277227

Returns the confidence surface type based on information from a GeoStan match.

Syntax

From copy book GDLCOPY:
      05 GDL-CONFIDENCE-SURFACE-TYPE.
      10 GDL-CST-HANDLE PIC S9(09) BINARY.
      10 GDL-CST-CONF-SUR-TYPE PIC S9(09) BINARY.
      88 GDL-SURF-UNDEFINED VALUE 0.
      88 GDL-SURF-ERROR VALUE 1.
      88 GDL-SURF-INTERSECTION VALUE 2.
      88 GDL-SURF-ADDRESS VALUE 3.
      88 GDL-SURF-POINT VALUE 4.
      88 GDL-SURF-AREA1 VALUE 5.
      88 GDL-SURF-AREA2 VALUE 6.
      88 GDL-SURF-AREA3 VALUE 7.
      88 GDL-SURF-AREA4 VALUE 8.
      88 GDL-SURF-POSTAL1 VALUE 9.
      88 GDL-SURF-POSTAL2 VALUE 10.
      88 GDL-SURF-POSTAL3 VALUE 11.
      88 GDL-SURF-POSTAL4 VALUE 12.
      10 GDL-RETURN-CODE PIC S9(09) BINARY.
      *
      MOVE GDL-INIT-HANDLE TO GDL-CST-HANDLE. CALL "GDLCST"
      USING GDL-CONFIDENCE-SURFACE-TYPE, GDL-RETURN-CODE

Arguments

GDL-CONFIDENCE-SURFACE-TYPE

Identifies the gdlHandle. Input.

GDL-RETURN-CODE

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 Success
GDL-NOT- LICENSED

Prerequisites

GDLINIT and GDLGES

Alternates

None.

Notes

The error (or confidence) surface type indicates the type of location that the surface encloses.

The enum definition, GDLGES, 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.