Directory Search Exit Program


  Required Parameter Group:

1 Function being requested Input Char(10)
2 Maximum entries for addressees Input Binary(4)
3 Maximum entries for copy list Input Binary(4)
4 Number of array elements Output Binary(4)
5 Array Output Char(*)
6 Maximum entries for blind copy list Input Binary(4)

 QSYSINC Member Name:  EOKDRSH1

The Directory Search exit program allows the administrator to define a customized search of directory data. The exit will perform one of three functions: display, select, or optional select. In this way, a user-customized search is provided and this search is integrated with OfficeVision programs and the system distribution directory.

Use the Change System Directory Attributes (CHGSYSDIRA) command to specify the Directory Search exit program name in the SCHPGM parameter. When F10 is pressed on the Search System Directory display, the Directory Search exit program is called.


Authorities and Locks

None.


Required Parameter Group

Function being requested
INPUT; CHAR(10)

The type of search operation that was requested.

*DISPLAY Search and display directory information.
*SELECT Search and select user IDs. The output includes user IDs and addresses selected as a result of a search function.
*OPTSELECT Search and select user IDs for addressees and copy list.

Maximum entries for addressees
INPUT; BINARY(4)

The maximum number of entries that can be selected for the addressees of the distribution. The maximum number allowable is 100.

This parameter is used with the *SELECT and *OPTSELECT values of the function being requested parameter. If the function is *DISPLAY, this value is 0 indicating no output is returned.

Maximum entries for copy list
INPUT; BINARY(4)

The maximum number of entries that can be selected to be copied on the distribution. This is the maximum number of entries that can be returned in the array parameter with the value of 2 in select option used field. The maximum number allowable is 100.

This value is used with the *OPTSELECT value of the function being requested parameter. If the function is either *SELECT or *DISPLAY, this value is 0 indicating no output is returned.

Number of array elements
OUTPUT; BINARY(4)

For the values *SELECT and *OPTSELECT, the number of users that is returned. The maximum value is the total of the maximum entries for addressees parameter plus the maximum entries for copy list parameter.

Array
OUTPUT; CHAR(*)

For the values *SELECT and *OPTSELECT, the array of the user IDs and addresses selected from the search function. For the format of this character parameter follows.

Offset Type Field
Dec Hex
0 0 CHAR(1) Select option used
1 1 CHAR(8) User ID
9 9 CHAR(8) User address
17 11 CHAR(50) User's full name or description

Maximum entries for blind copy list
INPUT; BINARY(4)

The maximum number of entries that can be selected to be blind copied on the distribution. This is the maximum number of entries that can be returned in the array parameter with the value of 4 in select option used field. The maximum number allowable is 100.

This value is used with the *OPTSELECT value of the function being requested parameter. If the function is either *SELECT or *DISPLAY, this value is 0 which indicates that no output is returned.


Field Descriptions

Select option used. The number of the option you want to use. The following are the possible values:

1 Addressee list
2 Carbon copy list (used only with *OPTSELECT)
4 Blind copy list (used only with *OPTSELECT)

User address. The second part of a two-part network name used in the system distribution directory and in the office applications to uniquely identify a user and to send electronic mail.

User ID. The first part of a two-part network name used in the system distribution directory and in the office applications to uniquely identify a user.

User's full name or description. The user's full name or any description up to 50 characters.


Exit Program Introduced: V2R2
Top | Office APIs | APIs by category