GSCITYFF - geostan_1 - 2024.01

GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > GeoStan
Version
2024.01
Language
English
Product name
GeoStan
Title
GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS
Copyright
2024
First publish date
1994
Last updated
2024-07-29
Published on
2024-07-29T23:01:18.924000

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

Syntax

01 GSID                           PIC S9(9) BINARY.
01 GSFUNSTAT                      PIC S9(9) BINARY.
01 STATE-NAME                     PIC X(USER LEN).
01 CITY-NAME                      PIC X(USER LEN).
*
CALL "GSCITYFF" USING GSID, STATE-NAME, CITY-NAME, GSFUNSTAT.

Arguments

GSID   ID returned by GSINITWP for the current instance of GeoStan. Input.

GSFUNSTAT   Return value for the procedure. Output.

STATE-NAME   Proper state abbreviation for the searched state, or " " for a ZIP Code search. Input.

CITY-NAME   City to search for (may be just a partial string), or a 3-digit or 5-digit ZIP Code. Input.

Return Values

Record number of the city located, or zero if GeoStan did not find any cities.

Prerequisites

GSCLEAR

Notes

This procedure retrieves the record number of the first city in a state that matches the city or ZIP Code search string. For example, if the entered state string is CA and the city string is S, Geostan finds the first city that begins with S in California. If the entered city string is 803 and the state string is null, GeoStan the first city in that sectional center. GeoStan does not return cities in any predefined order.

Before each find procedure, call GSCLEAR to reset the internal buffers. If you do not reset the buffers, you may receive incorrect results with information from a previous find.