Z-GET01C

This document covers the following topics:


Description

Return the work and home address for a cabinet or nickname.

This subprogram is similar to Z-GETADR with the exception that it also returns the last name and first name of a nickname as well as the Private-flag for nicknames.

This subprogram can be used by different types of users. Depending on the type of user, the following functions are allowed:

  • Cabinet Administrator
    Return the addresses for cabinets (except for cabinet SYSCNT), for nicknames in cabinet SYSCNT, or for nicknames in the cabinet administrator's private cabinet.

  • System Administrator
    Return the address for cabinet SYSCNT, for nicknames in cabinet SYSCNT, or for nicknames in the system administrator's private cabinet.

  • Any Other User
    Return the addresses 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 (except SYSCNT). User ID of a cabinet administrator. The name of a specific cabinet; or an asterisk (*); or letter(s) followed by an asterisk (*).  
Return the address for cabinet SYSCNT. User ID of a system administrator. The cabinet name "SYSCNT".  
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 of a cabinet administrator. 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 1=address (nickname), 5=all types of cabinets.
Private-flag A1   X If marked, this is a private address.
Last-name A32   X Valid only for a private cabinet.
First-name A32   X Valid only for a private cabinet.
Initial A1   X Valid only for a private cabinet.
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 The name of the cabinet which contains the nickname.
Work-title A32   X  
Work-company A32   X  
Work-location A32   X  
Work-address A60/1:3   X  
Work-city A32   X  
Work-country A8   X  
Work-department-name A32   X  
Work-department-number A10   X  
Work-phone A15   X  
Work-phone-country N2   X  
Work-phone-extension A10   X  
Work-postal-code A10   X  
Work-state A8   X  
Home-address A60/1:2   X  
Home-city A32   X  
Home-country A8   X  
Home-phone A15   X  
Home-phone-country N2   X  
Home-postal-code A10   X  
Home-state A8   X  
Work-parameter A83     For internal use. See The Work Parameter.

Return Codes

00 Success
02 Invalid cabinet name
03 Password incorrect
15 Invalid administrator status
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-1200&0

Example

See the example for Z-MOD01C.