DsReplicaGetInfo2W-Funktion (ntdsapi.h)
Die DsReplicaGetInfo2-Funktion ruft Replikationsstatusdaten aus dem Verzeichnisdienst ab. Diese Funktion ermöglicht das Paging von Ergebnissen in Fällen, in denen mehr als 1.000 Einträge abgerufen werden können.
Syntax
NTDSAPI DWORD DsReplicaGetInfo2W(
[in] HANDLE hDS,
[in] DS_REPL_INFO_TYPE InfoType,
[in, optional] LPCWSTR pszObject,
[in, optional] UUID *puuidForSourceDsaObjGuid,
[in, optional] LPCWSTR pszAttributeName,
[in, optional] LPCWSTR pszValue,
[in] DWORD dwFlags,
[in] DWORD dwEnumerationContext,
[out] VOID **ppInfo
);
Parameter
[in] hDS
Enthält ein Verzeichnisdiensthandle, das von der FUNKTION DSBind oder DSBindWithCred abgerufen wurde.
[in] InfoType
Enthält einen der DS_REPL_INFO_TYPE-Werte , der den Typ der abzurufenden Replikationsdaten angibt. Dieser Wert bestimmt auch, welcher Strukturtyp in ppInfo zurückgegeben wird.
[in, optional] pszObject
Zeiger auf eine konstante Unicode-Zeichenfolge mit NULL-Beendigung, die das Objekt identifiziert, für das Replikationsdaten abgerufen werden sollen. Die Bedeutung dieses Parameters hängt vom Wert des InfoType-Parameters ab. Im Folgenden sind mögliche Wertcodes aufgeführt.
DS_REPL_INFO_NEIGHBORS
pszObject identifiziert den Namenskontext, für den Replikationsnachbarn angefordert werden.
DS_REPL_INFO_CURSORS_FOR_NC
pszObject identifiziert den Benennungskontext, für den Replikationscursor angefordert werden.
DS_REPL_INFO_METADATA_FOR_OBJ
pszObject identifiziert das Objekt, für das Replikationsmetadaten angefordert werden.
DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES
pszObject muss NULL sein.
DS_REPL_INFO_KCC_DSA_LINK_FAILURES
pszObject muss NULL sein.
DS_REPL_INFO_PENDING_OPS
pszObject muss NULL sein.
DS_REPL_INFO_METADATA_FOR_ATTR_VALUE
pszObject identifiziert das Objekt, für das Attributreplikationsmetadaten angefordert werden.
DS_REPL_INFO_CURSORS_2_FOR_NC
DS_REPL_INFO_CURSORS_3_FOR_NC
DS_REPL_INFO_METADATA_2_FOR_OBJ
pszObject identifiziert das Objekt, für das Replikationsmetadaten angefordert werden.
DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE
pszObject identifiziert das Objekt, für das Attributreplikationsmetadaten angefordert werden.
[in, optional] puuidForSourceDsaObjGuid
Zeiger auf einen GUID-Wert , der eine bestimmte Replikationsquelle identifiziert. Wenn dieser Parameter nicht NULL ist und der InfoType-ParameterDS_REPL_INFO_NEIGHBORS enthält, werden nur Nachbardaten für die Quelle zurückgegeben, die dem nTDSDSA-Objekt mit dem angegebenen objectGuid im Verzeichnis entsprechen. Dieser Parameter wird ignoriert, wenn NULL oder der InfoType-Parameter etwas anderes als DS_REPL_INFO_NEIGHBORS ist.
[in, optional] pszAttributeName
Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen des spezifischen Attributs enthält, für das Replikationsdaten abgerufen werden sollen.
Dieser Parameter wird nur verwendet, wenn der InfoType-Parameter einen der folgenden Werte enthält.
DS_REPL_INFO_METADATA_FOR_ATTR_VALUE
DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE
[in, optional] pszValue
Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den wertigen Namen enthält, der übereinstimmen soll. Wenn das angeforderte Attribut ein Distinguished Name Type-Wert ist, gibt diese Funktion die Attribute zurück, die den angegebenen Wert enthalten.
[in] dwFlags
Enthält eine Reihe von Flags, die das Verhalten der Funktion ändern. Dieser Parameter kann null oder der folgende Wert sein.
DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS
Bewirkt, dass die Attributmetadaten Metadaten für die verknüpften Werte des Attributs berücksichtigen. Der resultierende Vektor stellt Änderungen für alle Attribute dar. Dieser geänderte Vektor ist nützlich für Clients, die erwarten, dass alle Attribute und Metadaten in den Attributmetadatenvektor einbezogen werden.
[in] dwEnumerationContext
Enthält den Index des nächsten abzurufenden Eintrags. Dieser Parameter muss beim ersten Aufruf dieser Funktion auf Null festgelegt werden.
Dieser Parameter wird nur verwendet, wenn der InfoType-Parameter einen der folgenden Werte enthält.
DS_REPL_INFO_CURSORS_2_FOR_NC
DS_REPL_INFO_CURSORS_3_FOR_NC
DS_REPL_INFO_METADATA_FOR_ATTR_VALUE
DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE
Diese Funktion ruft maximal 1.000 Einträge für jeden Aufruf ab. Wenn nach dem Aufrufen dieser Funktion weitere Einträge verfügbar sind, enthält das dwEnumerationContext-Element der abgerufenen Struktur den Index des nächsten abzurufenden Eintrags. Das dwEnumerationContext-Element der abgerufenen Struktur wird dann als dwEnumerationContext-Parameter beim nächsten Aufruf dieser Funktion verwendet. Wenn alle Einträge abgerufen wurden, enthält das dwEnumerationContext-Element der abgerufenen Struktur -1. Wenn -1 für diesen Parameter übergeben wird, gibt diese Funktion ERROR_NO_MORE_ITEMS zurück.
[out] ppInfo
Adresse eines Strukturzeigers, der die angeforderten Daten empfängt. Der Wert des InfoType-Parameters bestimmt das Format dieser Struktur. Weitere Informationen und eine Liste möglicher InfoType-Werte und der entsprechenden Strukturtypen finden Sie unter DS_REPL_INFO_TYPE.
Der Aufrufer muss diesen Arbeitsspeicher freigeben, wenn er nicht mehr benötigt wird, indem Er DsReplicaFreeInfo aufruft.
Rückgabewert
Gibt ERROR_SUCCESS zurück, wenn erfolgreich oder andernfalls ein Win32- oder RPC-Fehler auftritt. Im Folgenden sind mögliche Fehlercodes aufgeführt.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista |
| Unterstützte Mindestversion (Server) | Windows Server 2008 |
| Zielplattform | Windows |
| Kopfzeile | ntdsapi.h |
| Bibliothek | Ntdsapi.lib |
| DLL | Ntdsapi.dll |