| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Display Directory Entries (DSPDIRE) command is used to display, print, or create a database file for some or all system distribution directory entries. The database file output is displayed, printed, or created based on the following:
The DSPDIRE command does not update the directory. That function is provided interactively, with display support by the Work with Directory Entries (WRKDIRE) command, the Add Directory Entry (ADDDIRE) command, the Remove Directory Entry (RMVDIRE) command, the Change Directory Entry (CHGDIRE) command, and the Rename Directory Entry (RNMDIRE) command.
| Top |
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| USRID | User identifier | Single values: *ALL Other values: Element list |
Optional, Positional 1 |
| Element 1: User ID | Character value | ||
| Element 2: Address | Character value | ||
| USER | User profile | Name, *CURRENT | Optional, Positional 2 |
| OUTPUT | Output | *, *PRINT, *OUTFILE | Optional |
| OUTFILE | File to receive output | Qualified object name | Optional |
| Qualifier 1: File to receive output | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| OUTMBR | Output member options | Element list | Optional |
| Element 1: Member to receive output | Name, *FIRST | ||
| Element 2: Replace or add records | *REPLACE, *ADD | ||
| DETAIL | Detail | *BASIC, *FULL | Optional |
| OUTFILFMT | Outfile format | *TYPE1, *TYPE2, *TYPE3 | Optional |
| OUTDTA | Data to output | *LCL, *ALL | Optional |
| CMDCHRID | Command character identifier | Single values: *SYSVAL, *DEVD Other values: Element list |
Optional |
| Element 1: Graphic character set | Integer | ||
| Element 2: Code page | Integer |
| Top |
Specifies the user ID and address of the user for whom the directory entries are displayed, printed, or directed to a database file. If the USRID parameter is specified, the USER parameter cannot be specified.
For displayed output, if the user ID and address specify an entry that has only one description, the directory details for that entry are displayed. If several descriptions are associated with the specified user ID and address, a list of matching user IDs and addresses is displayed from which the user can select a user ID and address to view the details.
For printed output or database file output, the full directory details, including all descriptions for that user ID and address, are printed or sent to a database file. More information on specifying the user ID and address is in the SNA Distribution Services book, SC41-5410.
The possible user ID value is:
The possible user address value is:
| Top |
Specifies a user profile for which directory entries are displayed, printed, or written to a database file. If the USER parameter is specified, the USRID parameter cannot be specified.
For displayed output, if the profile specifies an entry that has only one description associated with it, the directory details for that entry are displayed. If multiple descriptions are associated with the specified profile, a list of all the user IDs and addresses matching the profile is displayed. The user can then select a user ID and address to view the details.
| Top |
Specifies whether the output from the command is shown at the requesting work station, printed with the job's spooled output, or written to an output file.
| Top |
Specifies the qualified name of the database file to which the output of the display is directed. If the database file does not exist, this command creates it in the specified library. If no library is specified, the database file is created in the user default library specified in the user profile. If no default library is specified, the database output file is created in the QGPL library.
If the database file is qualified with *LIBL but the system cannot find the file, the database file is created in the user's default library, if it is specified in the user profile. If the default library is not specified, the file is created in the QGPL library.
See the OUTFILFMT parameter for the valid output file types and their names.
The name of the database file can be qualified by one of the following library values:
| Top |
Specifies the name of the database file member to which the output is directed. If a member already exists, the system uses the second element of this parameter to determine whether the member is cleared before the new records are added. If the member does not exist and a member name is not specified, the system creates a member with the name of the output file specified on the OUTFILE parameter. If an output file member name is specified, but the member does not exist, the system creates it.
The possible member to receive output values are:
The possible operation to perform on member values are:
| Top |
Specifies how much detail is printed or directed to the database file. This parameter is not used when the output is directed to a display (OUTPUT(*)) or when a specific user ID or profile is specified.
When a user ID and address or user profile name is specified on an input parameter, the printed list contains one page of output with all descriptions included with the details for the user ID and address. The output file has a full detail record for each description. Only the description field is different between the records.
| Top |
Specifies the format of the output file.
If DETAIL(*BASIC) is specified, the output file contains only the basic fields, and the model output file QAOSDIRB is used with the record format name OSDIRB. If DETAIL(*FULL) is specified, the output file contains all of the detail fields, and the model output file QAOSDIRF is used with the record format name OSDIRF.
| Top |
Specifies the type of data to include as output to the value specified on the OUTPUT parameter. This parameter is not used when the output is directed to a display (OUTPUT(*)) or when a specific user ID or profile is specified.
| Top |
Specifies the character identifier (graphic character set and code page) for data being specified as parameter values on this command. This character identifier (CHRID) is related to the display device used to specify the command. More information about CHRID processing is in Application Display Programming book, SC41-5715.
The possible character set value is:
The possible code page value is:
| Top |
Example 1: Showing the Display for One Description
DSPDIRE USRID(HURST NEWYORK)
This command shows the Display Directory Entry Details display for user ID and address HURST NEWYORK if this user ID has only one description associated with it. If more than one description exists, the Display Directory Entries display is shown with all entries for the user ID and address.
Example 2: Printing Directory Information
DSPDIRE USER(JONES) OUTPUT(*PRINT)
This command prints the full directory details for user profile JONES. If there is more than one description in the directory for JONES, the printed output contains each description.
Example 3: Sending Full Details to a Database File
DSPDIRE OUTPUT(*OUTFILE)
OUTFILE(MYLIB/DIRLIST) OUTMBR(*FIRST *REPLACE)
DETAIL(*FULL)
This command sends a record to the database file DIRLIST in library MYLIB for each entry in the directory. This record contains the full details for each user. The format of the output file is the one used prior to Release 3.0 because of the default of OUTFILFMT(*TYPE1). If the file does not exist, it is created. If the file does exist, it is replaced.
Example 4: Sending Basic Information to a Database File
DSPDIRE OUTPUT(*OUTFILE)
OUTFILE(MYLIB/DIRLIST) DETAIL(*BASIC)
OUTFILFMT(*TYPE2)
This command sends a record to the database file named DIRLIST in the MYLIB library for each entry in the directory. The data contains only the basic fields, user ID, address, and description. If the file named DIRLIST in the MYLIB library already exists for releases 1.0 or 2.0 data (see Example 2), an error occurs; otherwise, the file is be created in the Release 3.0 format.
| Top |
*ESCAPE Messages
| Top |