G1CPLK-USER-RESULT-AREA - Code-1_Plus - 5.0

CODE-1 Plus Reference for all Platforms

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
CODE-1 Plus
Version
5.0
Language
English
Product name
CODE-1 Plus
Title
CODE-1 Plus Reference for all Platforms
Copyright
2024
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:07:55.920704

The following table provides a map of the returned information area for G1CPLKx.

Name

Length

Contents

G1CPLK-RMSG

79

This field contains any returned error or informational message.

G1CPLK-RETURN-CODES

4

G1CPLKx returns one of the following codes:

  • blank — The command was successful.

  • IN01 through IN09Non-fatal error — An invalid command string was specified in G1CPLK-COMMAND. The command may be invalid for one of two reasons:1 - It is an illegal command string.2 - The requested command is not allowed from    this point in the database hierarchy.

  • IN11 — Attempt to back up a level when none exists.

  • LK01 — Fatal error — Invalid command requested.

  • LK02 — Fatal error — Non-numeric SELECT FIELD passed.

  • LK03 — Fatal error — MAX-RETURN-CONTROL counter was out of range.

  • LK04 — Fatal error — Incompatible database found.

  • 0040 — Non-fatal error — ZIP Codes do not exist for the selected item.

  • 0041 — Non-fatal error — No firms exist for the selected item.

  • 0042 — Non-fatal error — No houses/apartments exist for the selected item.

  • 0043 — Non-fatal error — No apartments exist for the selected item.

  • 0045 — Non-fatal error — No streets exist for the selected item.

  • 0050 — Information — Alias information was returned in the G1CPLK-ALIASINFO field only. (Usually information is returned to the table in G1CPLK-DATA-TABL.)

 

G1CPLK-IPC-AREA-LENGTH

2

This 2-byte binary field contains the length of a communication area used internally. Do not modify this field.

G1CPLK-DB-SIGNATURE

95

The fields in this group item are populated as the result of the "OPEN" command. The field contains the month and year string of the vintage date of the database, as well as the expiration data. This field includes the following subfields:

  • G1CPLK-DB-DATE-STRING. This field contains the database month and year string for a length of 15.

  • G1CPLK-DB-PRODUCT. This field contains the software product name and version for a length of 50.

  • G1CPLK-DB-VINTAGE-DATE. This field contains the database vintage date in the MM/DD/YY format for a length of 10.

  • G1CPLK-DB-QUARTER-DATE. This field contains the database quarterly vintage date in the MM/DD/YY format for a length of 10.

  • G1CPLK-DB-EXPIRATION-DATE. This field contains the database expiration date in the MM/DD/YY format for a length of 10.

 

G1CPLK-LINE-BREAKDOWN

79

Used by the caller to examine lines returned by the call. Once a result set is returned, move each line here for further examination.

Name

Length

Contents

G1CPLK-BEG-COUNT

4

Position of the first database element reserved relative to all successive data in the database. For example, 40 for the 40th city in Maryland.

NOTE: This field is packed decimal consisting of 7 nibbles of binary-coded decimal digits and one nybble of sign.

G1CPLK-END-COUNT

4

Relative position of the last data elements available on the database.

NOTE: This field is packed decimal consisting of 7 nibbles of binary-coded decimal digits and one nybble of sign.

G1CPLK-ALIASINFO

80

Type and street name of the house range alias.

G1CPLK-RESULT-DATA

96

Data identified by G1CPLKx as required by the user (through G1CPLK-SELECT) to search further into the data.

G1CPLK-DATA-TABLE

25 (X 79)

25 occurrences of 79 bytes of data returned from the current request. The number of occurrences of valid data depends on the applicable G1CPLK-MAX-RETURN-CONTROL  value.

Filler

32

Reserved.