C API data types and functions

Initialization & termination functions

GsFileStatus

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

GsFileStatusEx

Returns information about the current GeoStan data set and license.

GsGetLibVersion

Returns the current version of the GeoStan library.

GsInitWithProps

Initializes GeoStan using properties.

GsTerm

Terminates GeoStan.

Last-line lookup

GsCityDataGet

Retrieves data for the found city record.

GsCityFindFirst

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

GsCityFindNext

Finds the next matching city.

GsFindFirstState

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

Address lookup

GsDataGet

Returns data for all address and matched elements from GeoStan.

GsDataSet

Passes data for all address elements to GeoStan.

GsFindWithProps

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

GsGetCoordsEx

Retrieves coordinates for the street segment found via GsFindWithProps.

GsMultipleGet

Returns the address elements for the match candidate specified

GsMultipleGetHandle

Returns the range handle for the match candidate specified.

GsNumMultiple

Returns the number of match candidates found.

GsSetSelection

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

Data querying

GsHandleGet

Retrieves data for objects found via GsFindFirst and GsFindNext.

GsHandleGetCoordsEx

Retrieves the coordinates for a street segment object found via GsFindFirst and GsFindNext.

GsGetDBMetadata

Populates the supplied buffer with the information about the item being queried for the specified database.

GsGetNumDB

Returns the number of loaded databases.

Error and message handling

GsErrorGet

Retrieves current error information.

GsErrorGetEx

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

GsErrorHas

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

Data passing functions

GsFindFirst___

Finds the first street, segment, or range object that meets the search criteria.

GsFindNext___

Finds the next street, segment, or range object that meets the search criteria.

GsSetSelectionRange

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

GsFindGeographicFirst

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

GsFindGeographicFirstEx

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

GsFindGeographicNext

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

GsFindGeographicNextEx

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

Utilities

GsClear

Clears the data buffer in the internal data structures.

GsSoundex

Generates a soundex key for use in GsFindFirst.

GsTestRange

Tests if a house number falls within a range.

GsVerifyAuxiliaryRecord

Validates an auxiliary file record.

GsVerifyGSDDataPresent

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

GsZ4Changed

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

CASS report functions

GsFormatCASSHeader

Writes a CASS 3553 report to the header buffer argument.

GsWriteExtendCASSReport

Writes a USPS CASS report based on the specified template.

DPV report functions

GsDpvGetCompleteStats

Obtains the complete DPV statistics since the application initialized DPV.

GsDpvGetFalsePosDetail

Retrieves the detail record for a DPV false-positive report.

GsDpvGetFalsePosHeaderStats

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

GsFormatDpvFalsePosDetail

Formats a DPV false-positive detail record from GsDpvGetFalsePosHeaderStats.

GsFormatDpvFalsePosHeader

Formats a DPV false-positive header record with data from GsDpvGetFalsePosDetail.

LACSLink report functions

GsFormatLACSFalsePosDetail

Formats a LACS^Link false-positive detail record from GsLACSGetFalsePosDetail.

GsFormatLACSFalsePosHeader

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

GsLACSClearStats

Clears the LACS^Link statistics.

GsLACSGetCompleteStats

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

GsLACSGetFalsePosDetail

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

GsLACSGetFalsePosHeaderStats

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

Spatial query functions

GsFindFirstSegmentByMbr

Finds the first segment handle within the specified MBR.

GsFindNextSegmentByMbr

Finds the first segment handle within the specified MBR.

GsGetMbr

Returns an MBR for the specified geographic element.

GsPrepareIndexFinance

Prepares all .gsx files needed to cover the finance area.

GsPrepareIndexMbr

Prepares all .gsx files needed to cover the minimum bounding rectangle (MBR).

Property setting functions

GsPropSetAsStr

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

GsPropSetBool

Sets a boolean property.

GsPropSetDouble

Sets a double property.

GsPropSetLong

Sets an integer property.

GsPropSetPtr

Sets a pointer property.

GsPropSetStr

Sets a string property.

Property retrieving functions

GsPropGetBool

Retrieves a boolean property.

GsPropGetDouble

Retrieves a double property.

GsPropGetInfo

Retrieves information about a property.

GsPropGetLong

Retrieves an integer property.

GsPropGetPtr

Retrieves a pointer property.

GsPropGetStr

Retrieves a string property.

GsPropGetStrLen

Retrieves the length of the string value of a property.

Property list management

GsPropListCreate

Creates and initializes a property list for GeoStan initialization.

GsPropListClear

Clears (empties) a property list.

GsPropListDestroy

Destroys a property list.

GsPropFind

Finds a property in a property list.

GsPropFirst

Sets property iterator to first property.

GsPropGetNext

Iterates to the next sequential property in the property list.

GsPropListGetCount

Retrieves the number of properties in a property list.

GsPropListGetType

Retrieves the type of the property list.

GsPropListRead

Reads the property list from a file or character string.

GsPropListReset

Resets the property list to its default state.

GsPropRemove

Removes a property from the property list.

GsPropListWrite

Writes the property list to a file or character string.