3.2.6.4 Read Directory Begin

This event MUST be generated with the following arguments:

  • iDirectoryObjectType: A string that specifies the name of the subtype of DirectoryObject to be read from the directory.

  • iFilter: An array of attribute-filter expressions ([MS-MQDMPR] section 3.1.7.1.20) where the valid attributes are the set of directory attributes associated with a DirectoryObject of type iDirectoryObjectType. Each object that is returned by the read operation MUST satisfy all attribute-filter expressions in this array.

  • iAttributeList (Optional): An array of strings containing the names of the directory attributes associated with a DirectoryObject of type iDirectoryObjectType, to be read from the directory and included in the rDirectoryObject return value. If this argument is not supplied, all directory attributes will be read.

  • iAttributeSortOrder (Optional): An array of attribute-sort-order values (defined as follows). The elements of this array have a one-to-one correspondence with the elements of the iAttributeList array. This array represents the precedence that the corresponding attributes in the iAttributeList take when ordering the returned results.

 An attribute-sort-order value consists of the following:

SortPriority: A numeric value that indicates the order in which results would be sorted with respect to the corresponding attribute. An attribute that has a higher sort priority is given a higher precedence when sorting the result set. A value of zero indicates that the corresponding attribute is not used when sorting the results.

SortAscending: A Boolean value that indicates whether the corresponding attribute will be sorted in ascending order.

Return Values:

  • rStatus: A DirectoryOperationResult that indicates the result of this directory operation.

  • rQueryHandle: A HANDLE ([MS-DTYP] section 2.2.16) that the invoker can use to iterate through the result set. This value is undefined if rStatus does not equal DirectoryOperationResult.Success.

 The MQDS client MUST perform the following actions to process this event: