Directory manager domain’s specific gates

Table 37 summarizes the directory manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, and the functions provided by the gates.

Table 37. Directory manager domain’s specific gates
Gate Trace Function
DDDI
DD 0201
DD 0202
CREATE_DIRECTORY
ADD_ENTRY
DELETE_ENTRY
REPLACE_DATA
DDLO
DD 0301
DD 0302
LOCATE
DDBR
DD 0401
DD 0402
START_BROWSE
GET_NEXT_ENTRY
END_BROWSE

DDDI gate, CREATE_DIRECTORY function

The CREATE_DIRECTORY function of the DDDI gate is used to create a new directory with entry names of a given length.

Input parameters

DIRECTORY_NAME
is the four_character name of the directory to be created.
NAME_LENGTH
is the length of entry names in the directory. This value must be a multiple of four, and less than 256.

Output parameters

DIRECTORY_TOKEN
is the directory token
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID
DUPLICATE_DIRECTORY
INVALID_NAME_LEN

DDDI gate, ADD_ENTRY function

The ADD_ENTRY function of the DDDI gate is used to add an entry to a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
ENTRY_NAME
is the address of the entry name. The length is fixed for the directory.
DATA_TOKEN
is the data to be associated with the entry name in the directory.
SUSPEND
indicates whether Storage Manager GETMAIN requests should be conditional or unconditional. Takes one of the values:
YES|NO

Output parameters

DUPLICATE_DATA_TOKEN
is the data currently associated with the entry name if it already exists in the directory.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUPLICATE
INSUFFICIENT_STORAGE
INVALID INVALID_DIRECTORY

DDDI gate, DELETE_ENTRY function

The DELETE_ENTRY function of the DDDI gate is used to delete an entry from a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
ENTRY_NAME
is the address of the entry name. The length is fixed for the directory.

Output parameters

DATA_TOKEN
is the data associated with the entry name when it was deleted.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND
INVALID INVALID_DIRECTORY

DDDI gate, REPLACE_DATA function

The REPLACE_DATA function of the DDDI gate is used to replace the data associated with an existing entry name in a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
ENTRY_NAME
is the address of the entry name. The length is fixed for the directory.
NEW_DATA_TOKEN
is the new data to be associated with the entry name.
PRIOR_DATA_TOKEN
is an optional parameter that indicates the data expected to be associated with the entry name just prior to it being replaced.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NOT_FOUND
DATA_CHANGED
INVALID INVALID_DIRECTORY

DDLO gate, LOCATE function

The LOCATE function of the DDLO gate is used to locate the data associated with an existing entry name in a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
ENTRY_NAME
is the address of the entry name. The length is fixed for the directory.

Output parameters

DATA_TOKEN
is the data associated with the entry name.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND
INVALID INVALID_DIRECTORY

DDBR gate, START_BROWSE function

The START_BROWSE function of the DDBR gate is used to start an alphabetical browse through all of the entries in a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
AT_NAME
is the address of an entry name at which the browse is to start. The first name found will be the first which is greater than or equal to this in alphabetical order.
TASK_RELATED
is an optional parameter which indicates whether the browse will end at task end. It can be one of these values:
YES|NO

if not specified this parameter defaults to YES.

Output parameters

BROWSE_TOKEN
is the token for this browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_DIRECTORY

DDBR gate, GET_NEXT_ENTRY function

The GET_NEXT_ENTRY function of the DDBR gate is used to get the next entry name in alphabetical order in a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
BROWSE_TOKEN
is the token for the browse.
ENTRY_NAME
is a buffer in which the entry name will be returned.

Output parameters

DATA_TOKEN
is the token associated with the entry name.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION BROWSE_END
INVALID
INVALID_DIRECTORY
INVALID_BROWSE
INVALID_NAME

DDBR gate, END_BROWSE function

The END_BROWSE function of the DDBR gate is used to end a browse on a directory.

Input parameters

DIRECTORY_TOKEN
is the token for the directory.
BROWSE_TOKEN
is the token for the browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_DIRECTORY
INVALID_BROWSE
[[ Contents Previous Page | Next Page Index ]]