Reference Guide › Command Reference › GETENTRY Command

GETENTRY Command

Use the GETENTRY command to retrieve a USER, IDENTITY, SUBCONFIG, or PROFILE directory entry.

To retrieve a directory entry:

GETENTRY entry [("Options"]

Options:

[DISK | RDR]
[FILE [filename]]
[MSG | NOMSG]
[NOLock | Lock]
[STACK [FIFO | LIFO]]
[FIFO]
[LIFO]
[STEM stemname [.]]

Note: Options can be entered in any order

To get a directory profile:

GETENTRY entry (PROFILE "Options"

Options:

[DISK | RDR ]
[FILE [filename]]
[MSG | NOMSG]
[NOLock | Lock]
[STACK [FIFO | LIFO]]
[FIFO]
[LIFO]
[STEM stemname [.]]

Note: Options can be entered in any order

Definitions

entry

Specifies the name of the directory entry to retrieve.

entry (PROFile

Specifies name of the directory profile to retrieve.

[DISK | RDR]

Copies the directory entry to your (DISK) or sends it to your reader (RDR). The name of the directory entry file on your disk or in your reader is the user ID name; the file type is DIRECT.

[NOLock | Lock]

Locks (LOCK) the directory entry or directory profile using the LOCK command or does not lock (NOLOCK) the directory entry or directory profile.

Locking the entry prevents further updates by other users until you issue the REPENTRY command or another authorized user issues the UNLOCK command.

If you specify the NOLOCK option, you cannot later update the directory entry with the REPENTRY command. Do not use the GETENTRY command with the NOLOCK option and then lock it later with the LOCK command, because the user ID may have been updated in the meantime.

[STEM stemname[.]]

Specifies the name of REXX stem variable array containing the statements retrieved from the directory entry contents. Any filetype or filemode parameters are ignored. The array contains the directory entry definition, so no disk file is referenced. The number of statements in the directory entry is defined in element stemname.0, stemname.1 contains the first statement in the directory entry, and so on. The stem will be defined in the same REXX program which calls the GETENTRY command, after the command is called.

[FILE [ filename]]

[MSG | NOMSG]

[STACK [FIFO | LIFO]]

[FIFO]

[LIFO]

These options are explained in Common API Command Options.

Description

The GETENTRY command retrieves the current directory entry for the specified user ID or the specified directory profile. It places this file in your reader queue or on your A‑disk, as you specify.

CA VM:Director protects logon and link passwords from observation by replacing them with a string of eight asterisks. If there are no link passwords, three tokens of eight asterisks appear in their place.

Return Codes and Error Messages

The following table lists the return codes and error messages for the GETENTRY command.