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
Optional Parameter
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
Optional Parameter
is an optional parameter which indicates whether the browse will end at task end.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is INVALID:
  • INVALID_DIRECTORY
BROWSE_TOKEN
is the token for this browse.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_DDBRstart_browse.html | Timestamp icon Last updated: Monday, 5 June 2017