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

Функция DsReplicaGetInfo2 извлекает данные о состоянии репликации из службы каталогов. Эта функция позволяет разбиение результатов по страницам в случаях, когда требуется получить более 1000 записей.

Синтаксис

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
);

Параметры

[in] hDS

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

[in] InfoType

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

[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.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

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

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_2_FOR_OBJ

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

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

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

[in, optional] puuidForSourceDsaObjGuid

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

[in, optional] pszAttributeName

Указатель на строку Юникода, завершающуюся значением NULL, которая содержит имя конкретного атрибута, для которого требуется извлечь данные репликации.

Этот параметр используется, только если параметр InfoType содержит одно из следующих значений.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

[in, optional] pszValue

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

[in] dwFlags

Содержит набор флагов, которые изменяют поведение функции. Этот параметр может быть равен нулю или следующему значению.

DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS

Заставляет метаданные атрибута учитывать метаданные связанных значений атрибута. Результирующий вектор представляет изменения для всех атрибутов. Этот измененный вектор полезен для клиентов, которые ожидают, что все атрибуты и метаданные будут включены в вектор метаданных атрибутов.

[in] dwEnumerationContext

Содержит индекс следующей записи, извлекаемой. Этот параметр должен иметь нулевое значение при первом вызове этой функции.

Этот параметр используется, только если параметр InfoType содержит одно из следующих значений.

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

Эта функция извлекает не более 1000 записей при каждом вызове. Если после вызова этой функции доступны дополнительные записи, член dwEnumerationContext полученной структуры будет содержать индекс следующей записи для извлечения. Затем член dwEnumerationContext полученной структуры используется в качестве параметра dwEnumerationContext при следующем вызове этой функции. После извлечения всех записей элемент dwEnumerationContext полученной структуры будет содержать -1. Если для этого параметра передается значение -1, эта функция возвращает ERROR_NO_MORE_ITEMS.

[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

См. также раздел

Функции управления контроллером домена и репликацией

DsBind

DsReplicaFreeInfo