2.3.8.3 PermanentEntryID

The PermanentEntryID is a structure that identifies a specific object in the address book. Additionally, it encodes the constant NSPI Protocol interface (via the ProviderUID field) and enough information for a client to make a decision as to how to display the object to an end user.

Permanent Entry IDs are transmitted in the protocol as values with the Property Type PtypBinary.

An NSPI server MAY allow an object's distinguished name (DN) to change. If this happens, the server SHOULD map a Permanent Entry ID containing the old DN to the object with the new DN. When returning a PermanentEntryID to satisfy a query from an NSPI client, an NSPI server MUST use the most current version of an object's DN.<6>


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

ID Type

R1

R2

R3

ProviderUID (16 bytes)

...

...

R4

Display Type String

Distinguished Name (variable)

...

ID Type (1 byte): The type of this ID. The value is the constant 0x00. The server uses the presence of this value to identify this Entry ID as a Permanent Entry ID rather than an Ephemeral Entry ID.

R1 (1 byte): Reserved. All clients and servers MUST set this value to the constant 0x00.

R2 (1 byte): Reserved. All clients and servers MUST set this value to the constant 0x00.

R3 (1 byte): Reserved. All clients and servers MUST set this value to the constant 0x00.

ProviderUID (16 bytes): A FlatUID_r value, containing the constant GUID specified in Permanent Entry ID GUID (section 2.2.7). A server MUST treat any other value as an error condition.

R4 (4 bytes): Reserved. All clients and servers MUST set this value to the constant 0x00000001.

Display Type String (4 bytes): The display type of the object specified by this Permanent Entry ID. This value is expressed in little-endian format. Valid values for this field are specified in Display Types (section 2.2.3). The display type is not considered part of the object's identity; it is set in the PermanentEntryID by the NSPI server as a convenience to NSPI clients. An NSPI server MUST set this field when this data structure is returned in an output parameter. An NSPI server MUST ignore values of this field on input parameters.

Distinguished Name (variable): The DN of the object specified by this Permanent Entry ID. The value is expressed as a DN, as specified in [MS-OXOABK].