Z-GET01E

This document covers the following topics:


Description

Return the work and home address for a cabinet or nickname, including Cc and Miscellaneous information.

This subprogram is similar to Z-GET01D with the exception that all types of users can use this subprogram. In addition, the parameter list contains new Cc-3 parameters which apply to the mail status message, and the format of the Miscellaneous parameters has been increased to 10 lines.

The parameters are sorted according to their appearance in the online screen (with the exception of the Miscellaneous parameters which appear at the end of the list).

The Cc parameters are only valid for cabinets (object number 5 and 33). For nicknames (object number 1) they are always empty.

The following functions are available: return the addresses for all cabinets, for nicknames in cabinet SYSCNT, or for nicknames in the user's private cabinet.

You can specify one of the following in the parameter Cabinet-name or Nickname:

  • to display all addresses alphabetically, you specify an asterisk (*);

  • to display the addresses for all cabinets or nicknames that start with specific letters, you specify the letters followed by an asterisk (for example, SAG*);

  • to display the address for a specific cabinet or nickname, you specify its name.

This subprogram can be invoked iteratively, until the return code 77 indicates the end of the list.

The following table shows the parameters that are used for the different functions of this subprogram:

Function Cabinet Cabinet-name Nickname
Return the address for a cabinet. The name of the user's cabinet. The name of a specific cabinet; or an asterisk (*); or letter(s) followed by an asterisk (*).  
Return a nickname in cabinet SYSCNT. The cabinet name "SYSCNT".   A specific nickname; or an asterisk (*); or letter(s) followed by an asterisk (*).
Return a nickname from the user's private cabinet. The name of the cabinet in which the nickname is stored.   A specific nickname; or an asterisk (*); or letter(s) followed by an asterisk (*).

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R X To return the address for a cabinet, this must be the user ID. To return the address of a nickname, this must be the ID of the cabinet in which the nickname is stored. If the nickname is not found in the specified cabinet, but found in cabinet SYSCNT, SYSCNT is returned.
Password A8 R   The password of the above cabinet.
Cabinet-name A8 R* X See the description above. Either Cabinet-name or Nickname, not both.
Nickname A32 R* X See the description above. Either Nickname or Cabinet-name, not both.
Object-ISN P10   X The ISN of the cabinet or nickname.
Object-number N2   X One of the following: 1=address (nickname), 5=cabinet, 33=user ID (private cabinet).
Private-flag A1   X Valid only for a nickname. If marked, this is a private address.
Last-name A32   X Valid only for a private cabinet or external address.
First-name A32   X Valid only for a private cabinet or external address.
Initial A1   X Valid only for a private cabinet or external address.
Sex A10   X Valid only for a private cabinet or external address.
Nickname-for A44   X Valid only for a nickname. Last name and first name delimited by a comma.
Nickname-status N1   X Valid only for a nickname. Validates the structure (e.g. comma) of the parameter Nickname-for. 0=correct, 1=incorrect
Nickname-origin A8   X Valid only for a nickname. The name of the cabinet which contains the nickname.
Work-company A32   X  
Work-title A32   X  
Work-department-name A32   X  
Work-department-number A10   X  
Work-location A32   X  
Work-address A60/1:3   X  
Work-city A32   X  
Work-state A8   X  
Work-postal-code A10   X  
Work-country A8   X  
Work-phone-1-country N3   X  
Work-phone-1 A15   X  
Work-phone-1-extension A5   X  
Work-phone-2-country N3   X  
Work-phone-2 A15   X  
Work-phone-2-extension A5   X  
Mobile-phone-country N3   X  
Mobile-phone A15   X  
Mobile-phone-extension A5   X  
Fax-country N3   X  
Fax A15   X  
Fax-extension A5   X  
Cc-flag A1   X If marked, Cc has been set.
Cc A20   X Cc from the user address.
Cc-address-type N2   X One of the following: 1=address (nickname), 4=bulletin board, 5=cabinet, 33=user ID.
Cc-address-source A1   X Only if Cc-address-type is 1 (address): S=address is from cabinet SYSCNT. Blank=address is from Cabinet-name.
Cc-last-first-name A20   X Only if Cc-address-type is 1 (external address) or 33 (user ID). Blank if Cc-address-type is 1 and this is not an external address (e.g. nickname for user ID).
Cc-node-name A8   X Only if Cc-address-type is 1 (external address).
Cc-status A1   X Blank=Cc is valid. X=Cc of given Cc-address-type was not found in Con-nect.
Cc-2-flag A1   X If marked, Cc-2 has been set.
Cc-2 A20   X Cc 2 from the user address.
Cc-2-address-type N2   X One of the following: 1=address (nickname) ,4=bulletin board, 5=cabinet, 33=user ID.
Cc-2-address-source A1   X Only if Cc-2-address-type is 1 (address): S=address is from cabinet SYSCNT. Blank=address is from Cabinet-name.
Cc-2-last-first-name A20   X Only if Cc-2-address-type is 1 (external address) or 33 (user ID). Blank if Cc-2-address-type is 1 and this is not an external address (e.g. nickname for user ID).
Cc-2-node-name A8   X Only if Cc-2-address-type is 1 (external address).
Cc-2-status A1   X Blank=Cc-2 is valid. X=Cc-2 of given Cc-2-address-type was not found in Con-nect.
Cc-3-flag A1   X If marked, Cc-3 (i.e. Cc from the mail status message) has been set.
Cc-3 A20   X Cc from the mail status message.
Cc-3-address-type N2   X One of the following: 1=address (nickname) ,4=bulletin board, 5=cabinet, 33=user ID.
Cc-3-address-source A1   X Only if Cc-3-address-type is 1 (address): S=address is from cabinet SYSCNT. Blank=address is from Cabinet-name.
Cc-3-last-first-name A20   X Only if Cc-3-address-type is 1 (external address) or 33 (user ID). Blank if Cc-3-address-type is 1 and this is not an external address (e.g. nickname for user ID).
Cc-3-node-name A8   X Only if Cc-3-address-type is 1 (external address).
Cc-3-status A1   X Blank=Cc-3 is valid. X=Cc-3 of given Cc-3-address-type was not found in Con-nect.
E-mail A64   X  
Internet A64   X  
Home-address A60/1:2   X  
Home-city A32   X  
Home-state A8   X  
Home-postal-code A10   X  
Home-country A8   X  
Home-phone-country N3   X  
Home-phone A15   X  
Home-phone-extension A5   X  
Home-fax-country N3   X  
Home-fax A15   X  
Home-fax-extension A5   X  
Home-e-mail A64   X  
Miscellaneous-header A12/1:10   X  
Miscellaneous-description A64/1:10   X  
Work-parameter A83     For internal use. See The Work Parameter.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
03 Password incorrect
24 Security violation
53 Requested object does not exist
77 End of list
92 Supply either Cabinet-name or Nickname, not both
93 Supply either Cabinet-name or Nickname

Subprograms

Z-120
Z-122
Z-123
Z-710
Z-723
Z-1200&0

Example

0010 *
0020 * Example program to call Z-GET01E
0030 *
0040 DEFINE DATA
0050 LOCAL
0060 1 RETURN-CODE               (N2)
0070 1 CABINET                   (A8)
0080 1 PASSWORD                  (A8)
0090 1 CABINET-NAME              (A8)
0100 1 NICKNAME                  (A32)
0110 1 OBJECT-ISN                (P10)
0120 1 OBJECT-NUMBER             (N2)
0130 1 PRIVATE-FLAG              (A1)
0140 1 LAST-NAME                 (A32)
0150 1 FIRST-NAME                (A32)
0160 1 INITIAL                   (A1)
0170 1 SEX                       (A10)
0180 1 NICKNAME-FOR              (A44)
0190 1 NICKNAME-STATUS           (N1)
0200 1 NICKNAME-ORIGIN           (A8)
0210 1 WORK-COMPANY              (A32)
0220 1 WORK-TITLE                (A32)
0230 1 WORK-DEPARTMENT-NAME      (A32)
0240 1 WORK-DEPARTMENT-NUMBER    (A10)
0250 1 WORK-LOCATION             (A32)
0260 1 WORK-ADDRESS              (A60/1:3)
0270 1 WORK-CITY                 (A32)
0280 1 WORK-STATE                (A8)
0290 1 WORK-POSTAL-CODE          (A10)
0300 1 WORK-COUNTRY              (A8)
0310 1 WORK-PHONE-1-COUNTRY      (N3)
0320 1 REDEFINE WORK-PHONE-1-COUNTRY
0330   2 WORK-PHONE-1-C-A        (A3)
0340 1 WORK-PHONE-1              (A15)
0350 1 WORK-PHONE-1-EXTENSION    (A5)
0360 1 WORK-PHONE-2-COUNTRY      (N3)
0370 1 REDEFINE WORK-PHONE-2-COUNTRY
0380   2 WORK-PHONE-2-C-A        (A3)
0390 1 WORK-PHONE-2              (A15)
0400 1 WORK-PHONE-2-EXTENSION    (A5)
0410 1 MOBILE-PHONE-COUNTRY      (N3)
0420 1 REDEFINE MOBILE-PHONE-COUNTRY
0430   2 MOBILE-PHONE-C-A        (A3)
0440 1 MOBILE-PHONE              (A15)
0450 1 MOBILE-PHONE-EXTENSION    (A5)
0460 1 FAX-COUNTRY               (N3)
0470 1 REDEFINE FAX-COUNTRY
0480   2 FAX-C-A                 (A3)
0490 1 FAX                       (A15)
0500 1 FAX-EXTENSION             (A5)
0510 1 CC-FLAG                   (A1)
0520 1 CC                        (A20)
0530 1 CC-ADDRESS-TYPE           (N2)
0540 1 REDEFINE CC-ADDRESS-TYPE
0550   2 CC-ADDRESS-TYPE-A       (A2)
0560 1 CC-ADDRESS-SOURCE         (A1)
0570 1 CC-LAST-FIRST-NAME        (A20)
0580 1 CC-NODE-NAME              (A8)
0590 1 CC-STATUS                 (A1)
0600 1 CC-2-FLAG                 (A1)
0610 1 CC-2                      (A20)
0620 1 CC-2-ADDRESS-TYPE         (N2)
0630 1 CC-2-ADDRESS-SOURCE       (A1)
0640 1 CC-2-LAST-FIRST-NAME      (A20)
0650 1 CC-2-NODE-NAME            (A8)
0660 1 CC-2-STATUS               (A1)
0670 1 CC-3-FLAG                 (A1)
0680 1 CC-3                      (A20)
0690 1 CC-3-ADDRESS-TYPE         (N2)
0700 1 CC-3-ADDRESS-SOURCE       (A1)
0710 1 CC-3-LAST-FIRST-NAME      (A20)
0720 1 CC-3-NODE-NAME            (A8)
0730 1 CC-3-STATUS               (A1)
0740 1 E-MAIL                    (A64)
0750 1 INTERNET                  (A64)
0760 1 HOME-ADDRESS              (A60/1:2)
0770 1 HOME-CITY                 (A32)
0780 1 HOME-STATE                (A8)
0790 1 HOME-POSTAL-CODE          (A10)
0800 1 HOME-COUNTRY              (A8)
0810 1 HOME-PHONE-COUNTRY        (N3)
0820 1 REDEFINE HOME-PHONE-COUNTRY
0830   2 HOME-PHONE-C-A          (A3)
0840 1 HOME-PHONE                (A15)
0850 1 HOME-PHONE-EXTENSION      (A5)
0860 1 HOME-FAX-COUNTRY          (N3)
0870 1 REDEFINE HOME-FAX-COUNTRY
0880   2 HOME-FAX-C-A            (A3)
0890 1 HOME-FAX                  (A15)
0900 1 HOME-FAX-EXTENSION        (A5)
0910 1 HOME-E-MAIL               (A64)
0920 1 MISCELLANEOUS-HEADER      (A12/1:10)
0930 1 MISCELLANEOUS-DESCRIPTION (A64/1:10)
0940 1 WORK-PARAMETER            (A83)
0950 *
0960 END-DEFINE
0970 *
0980 MOVE 'Cabinet'  TO CABINET
0990 MOVE 'Password' TO PASSWORD
1000 MOVE 'Find-Cab' TO CABINET-NAME
1010 *
1020 REPEAT UNTIL RETURN-CODE NE 0
1030 *
1040   CALLNAT 'Z-GET01E' RETURN-CODE
1050      CABINET
1060      PASSWORD
1070      CABINET-NAME
1080      NICKNAME
1090      OBJECT-ISN
1100      OBJECT-NUMBER
1110      PRIVATE-FLAG
1120      LAST-NAME
1130      FIRST-NAME
1140      INITIAL
1150      SEX
1160      NICKNAME-FOR
1170      NICKNAME-STATUS
1180      NICKNAME-ORIGIN
1190      WORK-COMPANY
1200      WORK-TITLE
1210      WORK-DEPARTMENT-NAME
1220      WORK-DEPARTMENT-NUMBER
1230      WORK-LOCATION
1240      WORK-ADDRESS(*)
1250      WORK-CITY
1260      WORK-STATE
1270      WORK-POSTAL-CODE
1280      WORK-COUNTRY
1290      WORK-PHONE-1-COUNTRY
1300      WORK-PHONE-1
1310      WORK-PHONE-1-EXT
1320      WORK-PHONE-2-COUNTRY
1330      WORK-PHONE2
1340      WORK-PHONE-2-EXT
1350      MOBILE-PHONE-C
1360      MOBILE-PHONE
1370      MOBILE-PHONE-EXT
1380      FAX-C
1390      FAX
1400      FAX-EXT
1410      CC-FLAG
1420      CC
1430      CC-ADDRESS-TYPE
1440      CC-ADDRESS-SOURCE
1450      CC-LAST-FIRST-NAME
1460      CC-NODE-NAME
1470      CC-STATUS
1480      CC-2-FLAG
1490      CC-2
1500      CC-2-ADDRESS-TYPE
1510      CC-2-ADDRESS-SOURCE
1520      CC-2-LAST-FIRST-NAME
1530      CC-2-NODE-NAME
1540      CC-2-STATUS
1550      CC-3-FLAG
1560      CC-3
1570      CC-3-ADDRESS-TYPE
1580      CC-3-ADDRESS-SOURCE
1590      CC-3-LAST-FIRST-NAME
1600      CC-3-NODE-NAME
1610      CC-3-STATUS
1620      E-MAIL
1630      INTERNET
1640      HOME-ADDRESS(*)
1650      HOME-CITY
1660      HOME-STATE
1670      HOME-POSTAL-CODE
1680      HOME-COUNTRY
1690      HOME-PHONE-C
1700      HOME-PHONE
1710      HOME-PHONE-EXT
1720      HOME-FAX-C
1730      HOME-FAX
1740      HOME-FAX-EXT
1750      HOME-E-MAIL
1760      MISCELLANEOUS-HEADER(*)
1770      MISCELLANEOUS-DESCRIPTION(*)
1780      WORK-PARAMETER
1790 *
1800   IF RETURN-CODE EQ 0  OR  RETURN-CODE EQ 77
1810     NEWPAGE
1820     WRITE NOTITLE NOHDR (AD=IOW' ')
1830     25T 'W o r k    A d d r e s s' /
1840      4T 'Last Name' LAST-NAME 2X 'Initial' INITIAL 7X 'Sex' SEX /
1850      3T 'First Name' FIRST-NAME /
1860      6T 'Company' WORK-COMPANY 2X 'Title' WORK-TITLE (AL=24) /
1870      3T 'Department' WORK-DEPARTMENT-NAME 'Number' WORK-DEPARTMENT-NUMBER /
1880      5T 'Location' WORK-LOCATION /
1890      6T 'Address' WORK-ADDRESS(1) /
1900      9T 'City' WORK-CITY WORK-STATE /
1910         'Postal Code' WORK-POSTAL-CODE 'Country' WORK-COUNTRY /
1920      6T 'Phone 1' WORK-PHONE-1-C-A WORK-PHONE-1 WORK-PHONE-1-EXTENSION6X
1930         'Phone 2' WORK-PHONE-2-C-A WORK-PHONE2 WORK-PHONE-2-EXTENSION/
1940      7T 'Mobile' MOBILE-PHONE-C-A MOBILE-PHONE MOBILE-PHONE-EXTENSION10X
1950         'Fax' FAX-C-A FAX FAX-EXTENSION/
1960      3T 'Set' CC-FLAG 'Cc  ' CC ' Type' CC-ADDRESS-TYPE
1970         'Node' CC-NODE-NAME '  Source' CC-ADDRESS-SOURCE /
1980      7T 'E-mail' E-MAIL /
1990     25T 'H o m e    A d d r e s s' /
2000         'Home Address' HOME-ADDRESS(1) /
2010      9T 'City' HOME-CITY HOME-STATE /
2020      2T 'Postal Code' HOME-POSTAL-CODE 'Country' HOME-COUNTRY /
2030      8T 'Phone' HOME-PHONE-C-A HOME-PHONE HOME-PHONE-EXTENSION/
2040     10T 'Fax' HOME-FAX-C-A HOME-FAX HOME-FAX-EXTENSION/
2050      7T 'E-mail' HOME-E-MAIL /
2060     25T 'M i s c e l l a n e o u s' /
2070          MISCELLANEOUS-HEADER(1) MISCELLANEOUS-DESCRIPTION(1) /
2080          MISCELLANEOUS-HEADER(2) MISCELLANEOUS-DESCRIPTION(2)
2090   ELSE
2100     WRITE 'Return code' RETURN-CODE
2110   END-IF
2120 END-REPEAT
2130 END