Функция DsReplicaGetInfoW (ntdsapi.h)

Статья
02/29/2024

Функция DsReplicaGetInfo извлекает данные о состоянии репликации из службы каталогов.

Синтаксис

NTDSAPI DWORD DsReplicaGetInfoW(
  [in]           HANDLE            hDS,
  [in]           DS_REPL_INFO_TYPE InfoType,
  [in, optional] LPCWSTR           pszObject,
  [in, optional] UUID              *puuidForSourceDsaObjGuid,
  [out]          VOID              **ppInfo
);

Параметры

[in] hDS

Содержит дескриптор службы каталогов, полученный из функции DSBind или DSBindWithCred .

[in] InfoType

Содержит одно из значений DS_REPL_INFO_TYPE , указывающее тип извлекаемых данных репликации. Это значение также определяет, какой тип структуры возвращается в ppInfo.

Для этой функции поддерживаются только следующие значения. Если требуются другие типы данных, необходимо использовать функцию DsReplicaGetInfo2 .

DS_REPL_INFO_NEIGHBORS

DS_REPL_INFO_CURSORS_FOR_NC

DS_REPL_INFO_METADATA_FOR_OBJ

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

DS_REPL_INFO_PENDING_OPS

[in, optional] pszObject

Указатель на константную строку Юникода, завершающуюся null, которая определяет объект, для которого требуется извлечь данные репликации. Значение этого параметра зависит от значения параметра InfoType . Ниже приведены возможные коды значений.

DS_REPL_INFO_NEIGHBORS

pszObject определяет контекст именования, для которого запрашиваются соседи репликации.

DS_REPL_INFO_CURSORS_FOR_NC

pszObject определяет контекст именования, для которого запрашиваются курсоры репликации.

DS_REPL_INFO_METADATA_FOR_OBJ

pszObject определяет объект, для которого запрашиваются метаданные репликации.

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

PszObject должен иметь значение NULL.

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

PszObject должен иметь значение NULL.

DS_REPL_INFO_PENDING_OPS

PszObject должен иметь значение NULL.

[in, optional] puuidForSourceDsaObjGuid

Указатель на значение GUID , определяющее конкретный источник репликации. Если этот параметр не равен NULL и параметр InfoType содержит DS_REPL_INFO_NEIGHBORS, возвращаются только соседние данные для источника, соответствующего объекту nTDSDSA с заданным objectGuid в каталоге. Этот параметр игнорируется, если значение NULL или параметр InfoType не является DS_REPL_INFO_NEIGHBORS.

[out] ppInfo

Адрес указателя структуры, который получает запрошенные данные. Значение параметра InfoType определяет формат этой структуры. Дополнительные сведения и список возможных значений InfoType и соответствующих типов структур см. в разделе DS_REPL_INFO_TYPE.

Вызывающий объект должен освободить эту память, если она больше не требуется, вызвав DsReplicaFreeInfo.

Возвращаемое значение

Возвращает ERROR_SUCCESS в случае успешного выполнения или ошибки Win32 или RPC. Ниже приведены возможные коды ошибок.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	ntdsapi.h
Библиотека	Ntdsapi.lib
DLL	Ntdsapi.dll