Z-GETADR

This document covers the following topics:


Description

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

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), or for nicknames in the cabinet administrator's own private cabinet.

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

  • Any Other User
    Return the addresses for nicknames in the user's own private cabinet.

This subprogram also returns the addresses for nicknames in cabinets that the above listed users are authorized to use (for example, shared cabinets and public cabinets).

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" (for system administrators only).   A specific nickname; or an asterisk (*); or letter(s) followed by an asterisk (*).
Return a nickname from the user's private cabinet or from a cabinet that the user is authorized to use. 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   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.
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 If marked, this is a private address.
Last-name A32   X  
First-name A32   X  
Initial A1   X  
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 A88     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
15 Invalid administrator status
53 Requested object does not exist
77 End of list
92 You can either specify Cabinet-name or Nickname, you must not specify both
93 You must specify the parameter Cabinet-name or Nickname

Subprograms

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

Example

See the example for Z-MODADR.