Finds the first geographic information record with partial matching to input names.
Syntax
01 GSID PIC S9(9) BINARY.
01 GSFUNSTAT PIC S9(9) BINARY.
*
MOVE SPACES TO GS-GEOGRAPHIC-INFO.
MOVE <a City Name> TO GS-INPUT-CITY.
MOVE <a County Name> TO GS-INPUT-COUNTY.
MOVE <a State Name/Abbreviation> TO GS-INPUT-STATE.
CALL "GSFGF" USING GSID, GS-GEOGRAPHIC-INFO, GSFUNSTAT.Arguments
GSID Returned by GSINITWP for the current instance of GeoStan. Input.
GSFUNSTAT Return value for the procedure. Output.
GS-INPUT-CITY City Name (may be a partial string). Input.
GS-INPUT-COUNTY County Name (may be a partial string). Optional. Input.
GS-INPU-STATE Proper state abbreviation or name for the searched state. Input.
Return Values
First Geographic Information Record which has a partial match to the input.
"GSFUNSTAT" contains a value of "GS-SUCCESS" if there are one or more matching records.
The following named items are defined in module the COBOL copy member "GEOSTAN" for this function:
|
GS-OUTPUT-CITY |
Full City name. |
|
GS-OUTPUT-COUNTY |
County name. |
|
GS-OUTPUT-STATE |
State FIPS abbreviation. |
|
GS-OUTPUT-LAT |
Latitude. |
|
GS-OUTPUT-LONG |
Longitude. |
|
GS-OUTPUT-RANK |
Metropolitan Area Economic and Population Rank. |
|
GS-OUTPUT-RESULT-CODE |
GeoStan Match result code. |
|
GS-OUTPUT-LOCATION-CODE |
Geostan Location code. |
|
GS-CLOSE-MATCH-FLAG |
Indicates close name match. |
Prerequisites
GSINITWP
Notes
This procedure retrieves the first Geographic information record which matches the input city, county, or state names. The match logic may qualify more than one response. Use calls to "GSFGN" to retrieve the additional responses.
The COBOL copy member "GEOSTAN" includes the record "GS-GEOGRAPHIC-INFO" which has the correct format for this function.
Input values may be zero-byte terminated strings or fixed-length with space padding. The returned values are fixed-length with space padding. The optional field "GS-INPUT-COUNTY" should be filled with spaces if it is not used.