Retrieves data located with GSCITYFF or GSCITYFN.
Syntax
01 GSID PIC S9(9) BINARY.
01 GSFUNSTAT PIC 9(9) BINARY.
01 GSOPTIONS PIC 9(9) BINARY.
01 OUTLEN PIC 9(9) BINARY.
01 CITY-NAME PIC X(USER LEN).
01 RECNUM PIC S9(9) BINARY.
*
CALL "GSCITYDG" USING GSID, RECNUM, GSOPTIONS, CITY-NAME, OUTLEN, GSFUNSTAT.Arguments
GSID ID returned by GSINITWP for the current instance of GeoStan. Input.
GSFUNSTAT Return value for the procedure. Output.
GSOPTIONS Symbolic constant for the data item to retrieve. The following table lists the valid variables. Input.
|
Variable |
Size |
Description |
|---|---|---|
|
GS-CITY-CARRTSORT |
(2) |
•Y – Carrier Route Sort •N – No Carrier Route Sort |
|
GS-CITY-CITYDELV |
(2) |
•Y – Has city-delivery carrier routes •N – Does not have city-delivery carrier routes |
|
GS-CITY-CLASS |
(2) |
ZIP Classification Code. |
|
GS-CITY-CTYSTKEY |
(7) |
6-character USPS City State Key that uniquely identifies a locale in the city/state file. |
|
GS-CITY-FACILITY |
(2) |
Returns USPS City State Name Facility Code: •A – Airport Mail Facility (AMF) •B – Branch •C – Community Post Office (CPO) •D – Area Distribution Center (ADC) •E – Sectional Center Facility (SCF) •F – Delivery Distribution Center (DDC) •G – General Mail Facility (GMF) •K – Bulk Mail Center (BMC) •M – Money Order Unit •N – Non-Postal Community Name, Former Postal Facility, or Place Name •P – Post Office •S – Station •U – Urbanization |
|
GS-CITY-MAILIND |
(2) |
•1 – Can use City State Name as last line on mail piece •0 – Cannot use City State Name as last line on main piece |
|
GS-CITY-NAME |
(30) |
City name (may be an alternate name) |
|
GS-CITY-PREFNAME |
(30) |
USPS preferred city name |
|
GS-CITY-QCITY |
(10) |
City number, using the format ssffffccc, where s is the state number, f is the Finance number, and c is the city number |
|
GS-CITY-UNIQUE |
(2) |
•Y – Unique ZIP Code (ZIP assigned to a single organization) •Blank – Not applicable |
|
GS-CITY-STATE |
(3) |
State Abbreviation |
|
GS-CITY-ZIP |
(6) |
ZIP Code |
CITY-NAME Location to store the returned data. Output.
OUTLEN Maximum size of data to return in buffer. If OUTLEN is shorter than the data returned by GeoStan, GeoStan truncates the data and does not generate an error. Input.
RECNUM City record number, as returned by GSCITYFF or GSCITYFN. Input.
Return Values
GS-SUCCESS
GS-ERROR
Prerequisites
GSCITYFF or GSCITYFNNotes
The GSCITYDG procedure retrieves data about the city located with GSCITYFF or GSCITYFN. City information from the USPS City/State file.