Z-GET01B

This document covers the following topics:


Description

Return information about a nickname for an address at an external node or for an internal Con-nect address.

This subprogram is similar to Z-GET01 with the exception that it returns the Private-flag for nicknames, the last name and first name of a user at an external node as well as the security levels for the nickname or user.

This subprogram does not apply to a transport service node. To return information about a nickname for a transport service node, you must use Z-GET01T.

The parameters Node-name, Node-parameters, Parameter-length, Post-flag, Last-name and First-name only apply to an external address. They do not apply to an internal address.

This subprogram is generally used with Z-MOD01A to allow the modification of addressee information. The addressee information is then used by Z-MAILA for the distribution of mail.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R X 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.
Nickname A20 R* X The nickname for which you want to get information. Input: either Nickname or ISN; not both.
ISN P10 R* X The ISN of the nickname for which you want to get information. Input: either ISN or Nickname; not both.
Last-name A32   X The last name of a user at an external node.
First-name A32   X The first name of a user at an external node.
Description A60/1:4   X The description of the nickname.
Folder-name A15   X The folder in which the nickname is stored.
File-name A15   X The file within the above folder in which the nickname is stored.
Node-name A8   X The name of the external node which has been added by the administrator. Applies only to an external nickname.
Node-parameters A250   X The physical address of the external node. Applies only to an external nickname. See External Communication.
Parameter-length N3   X Depends upon the Node-parameters. Applies only to an external nickname.
Post-flag A1   X Applies only to an external nickname. If marked, a window appears and you can enter additional information before the mail is sent. However, the window only appears when you use online Con-nect. If you use Z-MAILA to send mail, the window does not appear.
Private-flag A1   X If marked, the nickname is a private object.
Security-flags A4   X The security levels for Read, Modify, Copy and Print. Values between 0 and 9.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
03 Password incorrect
04 ISN was not found
08 Supply either ISN or name, not both
09 ISN does not point to correct object
24 Security violation
91 Invalid nickname
93 The nickname does not exist

Subprograms

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

Example

0010 DEFINE DATA
0020 LOCAL
0030 1 RETURN-CODE            (N2)
0040 1 CABINET                (A8)
0050 1 PASSWORD               (A8)
0060 1 NICKNAME               (A20)
0070 1 ISN                    (P10)
0080 1 LAST-NAME              (A32)
0090 1 FIRST-NAME             (A32)
0100 1 DESCRIPTION            (A60/1:4)
0110 1 FOLDER-NAME            (A15)
0120 1 FILE-NAME              (A15)
0130 1 NODE-NAME              (A8)
0140 1 NODE-PARAMETERS        (A250)
0150 1 PARAMETER-LENGTH       (N3)
0160 1 POST-FLAG              (A1)
0170 1 PRIVATE-FLAG           (A1)
0180 1 SECURITY-FLAGS         (A4)
0190 1 REDEFINE SECURITY-FLAGS
0200   2 SECURITY-READ        (A1)
0210   2 SECURITY-MODIFY      (A1)
0220   2 SECURITY-COPY        (A1)
0230   2 SECURITY-PRINT       (A1)
0240 END-DEFINE
0250 *
0260 RESET RETURN-CODE
0270 MOVE 'USER ID'    TO CABINET
0280 MOVE 'PW'         TO PASSWORD
0290 MOVE 'NICKNAME 1' TO NICKNAME
0300 *
0310 CALLNAT 'Z-GET01B' RETURN-CODE
0320                    CABINET
0330                    PASSWORD
0340                    NICKNAME
0350                    ISN
0360                    LAST-NAME
0370                    FIRST-NAME
0380                    DESCRIPTION(*)
0390                    FOLDER-NAME
0400                    FILE-NAME
0410                    NODE-NAME
0420                    NODE-PARAMETERS
0430                    PARAMETER-LENGTH
0440                    POST-FLAG
0450                    PRIVATE-FLAG
0460                    SECURITY-FLAGS
0470 *
0480 IF RETURN-CODE EQ 0
0490    WRITE 'Return status' ' OK' (AD=OI)
0500 ELSE
0510    WRITE 'Return code' RETURN-CODE
0520 END-IF
0530 *
0540 END