instance

Specifies an output that contains the requested information about an entry.

Description

The <instance> element is an output that is sent with the status command as a reply to a query command.

An <instance> element is returned for each entry that matches the search filter of the query.

Definition

  <!ELEMENT instance      (association?, parent?, attr*)>
  <!ATTLIST instance
            src-dn         CDATA            #IMPLIED
            src-entry-id   CDATA            #IMPLIED
            class-name     CDATA            #REQUIRED
            event-id       CDATA            #IMPLIED>
  
  

Attributes

src-dn
Specifies the distinguished name of the entry being returned in the name space of the sender.
src-entry-id
Specifies the entry ID of the entry being returned in the name space of the sender. It should be ignored by the driver.
class-name
Specifies the base class of the entry being returned.
event-id
Specifies the event-id of the query, if the query contained an <event-id> element.

Elements

association
Specifies the unique identifier for the entry being returned.
parent
Specifies the parent container of the entry, if requested by the query.
attr
Specifies attributes and values, if the query requested them

Reply Format

When the DirXML driver returns an <instance> element, the element must contain an <association> element.

When the DirXML engine returns an <instance> element, the element contains an <association> element if one has been formed for the entry.

Parent

Example

The following example illustrates an <instance> element.

  <instance class-name="User" src-dn="\Users\Samuel">
     <association>1012</association>
     <attr attr-name="Surname">
        <value>Jones</value>
     </attr>
     <attr attr-name="cn">
        <value>Samuel</value>
     </attr>
     <attr attr-name="Given Name">
        <value>Samuel</value>
     </attr>
     <attr attr-name="Telephone Number">
        <value>555-1212</value>
        <value>555-1764</value>
     </attr>
  </instance>