5.20 DSP Replica Information Flags

The following table lists the DSP flags. These flags affect the information returned by NWDSListPartitionsExtInfo, NWDSGetPartitionExtInfoPtr, and NWDSGetPartitionExtInfo.

You can access the additional information by calling NWDSListPartitionsExtInfo, NWDSGetPartitionExtInfoPtr, and NWDSGetPartitionExtInfo in this specific order.

If the client does not request the DSP_OUTPUT_FIELDS flag, the server must return exactly the information requested in the DSP information flags. If the server does not support the information of a requested flag, an error results. If the client requests the DSP_OUTPUT_FIELDS flag, the server can skip the flags it doesn’t support, and the server informs the client of the skip by clearing the corresponding bit in the DSP_OUTPUT_FIELDS flag.

Flag Name and C Value

Data Type

Meaning

DSP_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 DSP flags, the server clears the corresponding bit in the DSP_OUTPUT_FIELDS flag. The client tests the bits in the DSP_OUTPUT_FIELDS flag to determine which fields are present in the reply.

No matter which bits are set, the order of the returned data is the same as the requested order.

DSP_PARTITION_ID

0x00000002L

nuint32

Returns the Entry ID of the partition’s root object on the local server.

DSP_REPLICA_STATE

0x00000004L

nuint32

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

DSP_MODIFICATION_TIMESTAMP

0x00000008L

NWDS_TimeStamp_T structure

Returns the time and the event ID for the most recent modification to the replica.

DSP_PURGE_TIME

0x00000010L

nuint32

Returns the time at which all data has been synchronized. Data, scheduled for deletion, that predates this time, can now be deleted.

DSP_LOCAL_PARTITION_ID

0x00000020L

nuint32

Returns the Entry ID of the partition.

DSP_PARTITION_DN

0x00000040L

NULL terminated string

Returns the distinguished name of the partition. Buffer size should be MAX_DN_BYTES.

DSP_REPLICA_TYPE

0x00000080L

nuint32

Returns the replica’s state (see Section 5.24, Replica States) in the high 16 bits and the replica’s type (see Section 5.23, Replica Types) in the low 16 bits.

DSP_PARTITION_BUSY

0x00000100L

nbool

Indicates whether the partition is busy merging a tree or moving a subtree.

When set to one (1), the partition is busy.

When set to zero (0), the partition is not busy.