5.11 DCK_DSI_FLAGS Values

The following table lists the flags the DCK_DSI_FLAGS key uses. They are defined in the nwdsdc.h file. These DSI flags affect the information returned by the NWDSReadObjectInfo, NWDSList, NWDSReadObjectDSIInfo, and NWDSGetDSIInfo functions.

If you remove the default flags from the context handle, the NWDSReadObjectInfo and NWDSGetDSIInfo functions that follow the NWDSList function will be affected.

If you add flags to the context handle, you can access the additional information by calling the NWDSReadObjectDSIInfo function or by calling the NWDSList, NWDSGetObjectNameAndInfo, and NWDSGetDSIInfo functions in this specific order.

Flag Name and C Value

Data Type

Description

DSI_OUTPUT_FIELDS

0x00000001L

nuint32

Specifies which requested fields of information are actually returned. If the server cannot provide one of the items requested by the DSI flags, the server clears the corresponding bit in the Output Fields flag. No matter which bits are set, the order of the returned data is the same as the requested order.

DSI_ENTRY_ID

0x00000002L

nuint32

Returns the Entry ID of the object.

DSI_ENTRY_FLAGS:

0x00000004L

nuint32

Returns the type of entry. See Section 5.12, DSI_ENTRY_FLAGS Values.

DSI_SUBORDINATE_COUNT

0x00000008L

nuint32

Returns the number of objects that are subordinate to the specified object, or 0 if unknown.

DSI_MODIFICATION_TIME

0x00000010L

nuint32

Returns when the object was lasted modified, or 0 if unknown.

DSI_MODIFICATION_TIMESTAMP

0x00000020L

Timestamp_T

Returns the object’s modification timestamp, or 0 if unknown.

DSI_CREATION_TIMESTAMP

0x00000040L

Timestamp_T

Returns the object’s creation timestamp, or 0 if unknown.

DSI_PARTITION_ROOT_ID

0x00000080L

nuint32

Returns the Entry ID of the partition’s root entry.

DSI_PARENT_ID

0x00000100L

nuint32

Returns the Entry ID of the object’s parent.

DSI_REVISION_COUNT

0x00000200L

nuint32

Returns the number of times the object has been modified.

DSI_REPLICA_TYPE

0x00000400L

nuint32

Returns the replica type:

  • 0 RT_MASTER

  • 1 RT_SECONDARY

  • 2 RT_READONLY

  • 3 RT_SUBREF

DSI_BASE_CLASS

0x00000800L

NULL terminated string

Returns the base class of the object.

DSI_ENTRY_RDN

0x00001000L

NULL terminated string

Returns the relative distinguished name, or partial name, of the object in the format specified by DCK_FLAGS and DCK_NAME_FORM (see Section 5.6, Context Keys and Flags).

DSI_ENTRY_DN

0x00002000L

NULL terminated string

Returns the distinguished name of the object in the format specified by the DCK_FLAGS (see Section 5.6, Context Keys and Flags). The name form is always comma delimited (not slash delmited), regardless of the setting for DCK_NAME_FORM.

DSI_PARTITION_ROOT_DN

0x00004000L

NULL terminated string

Returns the distinguished name of the partition root in the format specified by the DCK_FLAGS and DCK_NAME_FORM (see Section 5.6, Context Keys and Flags).

DSI_PARENT_DN

0x00008000L

NULL terminated string

Returns the distinguished name of the object’s parent in the format specified by the DCK_FLAGS and DCK_NAME_FORM (see Section 5.6, Context Keys and Flags).

DSI_PURGE_TIME

0x00010000L

nuint32

For a partition object, returns the oldest purge time.

DSI_DEREFERENCE_BASE_CLASS

0x00020000L

NULL terminated string

Returns the base class of the object the alias references.

DSI_REPLICA_NUMBER

0x00040000L

nuint32

Returns the number the replica was assigned when it was created.

DSI_REPLICA_STATE

0x00080000L

nuint32

Returns the state of the replica (see Section 5.24, Replica States).