Função DsReplicaGetInfoW (ntdsapi.h)

Artigo
02/29/2024

A função DsReplicaGetInfo recupera dados de estado de replicação do serviço de diretório.

Sintaxe

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

Parâmetros

[in] hDS

Contém um identificador de serviço de diretório obtido da função DSBind ou DSBindWithCred .

[in] InfoType

Contém um dos valores DS_REPL_INFO_TYPE que especifica o tipo de dados de replicação a serem recuperados. Esse valor também determina qual tipo de estrutura é retornado em ppInfo.

Somente os valores a seguir têm suporte para essa função. Se outros tipos de dados forem necessários, a função DsReplicaGetInfo2 deverá ser usada.

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

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo constante que identifica o objeto para o qual recuperar dados de replicação. O significado desse parâmetro depende do valor do parâmetro InfoType . A seguir estão possíveis códigos de valor.

DS_REPL_INFO_NEIGHBORS

pszObject identifica o contexto de nomenclatura para o qual os vizinhos de replicação são solicitados.

DS_REPL_INFO_CURSORS_FOR_NC

pszObject identifica o contexto de nomenclatura para o qual os cursores de replicação são solicitados.

DS_REPL_INFO_METADATA_FOR_OBJ

pszObject identifica o objeto para o qual os metadados de replicação são solicitados.

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

pszObject deve ser NULL.

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

pszObject deve ser NULL.

DS_REPL_INFO_PENDING_OPS

pszObject deve ser NULL.

[in, optional] puuidForSourceDsaObjGuid

Ponteiro para um valor GUID que identifica uma fonte de replicação específica. Se esse parâmetro não for NULL e o parâmetro InfoType contiver DS_REPL_INFO_NEIGHBORS, somente os dados vizinhos da fonte correspondentes ao objeto nTDSDSA com o objeto EspecificadoGuid no diretório serão retornados. Esse parâmetro será ignorado se NULL ou se o parâmetro InfoType for diferente de DS_REPL_INFO_NEIGHBORS.

[out] ppInfo

Endereço de um ponteiro de estrutura que recebe os dados solicitados. O valor do parâmetro InfoType determina o formato dessa estrutura. Para obter mais informações e lista de possíveis valores InfoType e os tipos de estrutura correspondentes, consulte DS_REPL_INFO_TYPE.

O chamador deve liberar essa memória quando ela não for mais necessária chamando DsReplicaFreeInfo.

Retornar valor

Retorna ERROR_SUCCESS se tiver êxito ou um erro Win32 ou RPC, caso contrário. Veja a seguir possíveis códigos de erro.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	ntdsapi.h
Biblioteca	Ntdsapi.lib
DLL	Ntdsapi.dll