COLBOL API variables and procedures

Variables for storing and retrieving data

Provides information on the variables used for GSHGET, GSDATSET, GSDATGET, and GSMGET.

Initialization & termination procedures

GSFSTAT

Returns if the file successfully opened, and the date of the USPS data used in generating the primary GSD file.

GSFSTATX

Returns a variety of information about the current GeoStan data set and license.

GSGLIBV

Returns the current version of the GeoStan library.

GSINITWP

Initializes GeoStan.

GSSCACHE

Sets the size of the cache GeoStan uses.

GSSLIC

Identifies license file and key.

GSSRELD

Allows you to specify the oldest acceptable date for GeoStan data files.

GSTERM

Terminates GeoStan.

Last-line lookup

GSCITYDG

Retrieves data for the found city record.

GSCITYFF

Finds the first city matching partial name or valid ZIP Code.

GSCITYFN

Finds the next matching city.

GSFFSTAT

Finds the first state matching name, abbreviation, or valid ZIP Code.

Address lookup

GSDATGET

Returns data for all address and matched elements from GeoStan.

GSDATSET

Passes data for all address elements to GeoStan.

GSFFRANG

Finds the first range object that meets the search criteria.

GSFFSEG

Finds the first segment that meets the search criteria.

GSFFST

Finds the first street object that meets the search criteria.

GSFNRANG

Finds the next range object that meets the search criteria.

GSFNSEG

Finds the next segment that meets the search criteria.

GSFNST

Finds the next street that meets the search criteria.

GSFINDWP

Finds a match with user settable match preferences (properties).

GSGCRDX

Retrieves coordinates for the street segment found via GSFINDWP.

GSMGET

Returns the address elements for the match candidate item specified.

GSMGH

Returns the range handle for the match candidate item specified.

GSNMULT

Returns the number of match candidates found.

GSSETSEL

Allows you to select a match from a set or match candidates.

Data querying

GSDBMETA

Retrieves coordinates for the street segment found via GSFINDWP.

GSGETNDB

Returns the number of loaded databases.

GSHGCRDX

Retrieves the coordinates for a street segment object found via GSFFSEG and GSFNRANG.

GSHGET

Retrieves data for objects found via GSFFSEG and GSFNRANG.

Error and message handling

GSERRGET

Retrieves current error information.

GSERRGTX

Retrieves informational messages, error messages, and fatal warnings for the current GeoStan thread.

GSERRHAS

Indicates if any errors occurred or any informational messages are available in the current thread.

Data passing procedures

GSSSELR

Allows GeoStan to use a record found outside of GSSFINDWP as a match.

GSFGF

Finds the first geographic information record with partial matching to input names.

GSFGFX

Finds the first city, county, and or state centroid match from the set of possible matches found.

GSFGN

Finds the next geographic information record with partial matching to input names.

GSFGNX

Finds the next city, county, and or state centroid match from the set of possible matches found.

Utilities

GSCLEAR

Clears the data buffer in the internal data structures.

GSSNDX

Generates a soundex key for use in GSFFSEG.

GSTSTRNG

Tests if a house number falls within a range.

GSVAUXR

Validates an auxiliary file record.

GSVGSDDT

Validates the presence of data for specified states in the GSD file.

GSZ4CH

Determines if the USPS changed a ZIP + 4 address definition since GeoStan last processed the record.

CASS report procedures

GSFCASSH

Writes a CASS 3553 report to the header buffer argument.

GSWECASS

Writes a USPS CASS report based on the specified template.

DPV report procedures

GSDPVGCS

Obtains the complete DPV statistics since the application initialized DPV.

GSDPVGFD

Retrieves the detail record for a DPV false positive report.

GSDPVGFH

Retrieves DPV statistics for the header record for a DPV false positive report.

GSFDFPD

Formats a DPV false positive detail record from GSDPVGFD.

GSFDFPH

Formats a DPV false positive header record with data from GSDPVGFD.

LACSLink report procedures

GSLACCLS

Clears the LACS^Link statistics.

GSLACFPD

Formats a LACS^Link false positive detail record from GSLACGFH.

GSLACFPH

Formats a LACS^Link false positive header record with data from GSLACGFH.

GSLACGCS

Obtains the complete LACS^Link statistics since the application initialized LACS^Link.

GSLACGFD

Retrieves the detail record for a LACS^Link false positive report.

GSLACGFH

Retrieves LACS^Link statistics for the header record for a LACS^Link false positive report.

Property setting procedures

GSPSETAS

Sets a property where input name and value are both strings.

GSPSETB

Sets a boolean property.

GSPSETD

Sets a double property.

GSPSETL

Sets an integer property.

GSPSETS

Sets a short integer property.

GSPSETST

Sets a string property.

Property retrieving procedures

GSPGETB

Retrieves a boolean property.

GSPGETD

Retrieves a double property.

GSPGETL

Retrieves a long integer property.

GSPGETST

Retrieves a string property.

GSPGINFO

Retrieves information about a property.

GSPGSTRL

Retrieves the length of the string value of a property.

Property list management

GSPFIND

Finds a property in a property list.

GSPFIRST

Sets property iterator to first property.

GSPFNEXT

Iterates to the next sequential property in the property list.

GSPLSTCR

Creates and initializes a property list for GeoStan initialization.

GSPLSTDE

Destroys a property list.

GSPLSTGC

Retrieves the number of properties in a property list.

GSPLSTWR

Writes the property list to a file or a character string.

GSPREMOV

Removes a property from the property list.

GSPRESET

Resets the property list to its default state.