Compartilhar via


Função DsReplicaGetInfo2W (ntdsapi.h)

A função DsReplicaGetInfo2 recupera dados de estado de replicação do serviço de diretório. Essa função permite a paginação de resultados em casos em que há mais de 1000 entradas a serem recuperadas.

Sintaxe

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

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

[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 . Veja a seguir os códigos de valor possíveis.

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.

pszObject deve ser NULL.

DS_REPL_INFO_PENDING_OPS

pszObject deve ser NULL.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

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

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_2_FOR_OBJ

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

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

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

[in, optional] puuidForSourceDsaObjGuid

Ponteiro para um valor GUID que identifica uma origem 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 correspondente ao objeto nTDSDSA com o objectGuid fornecido 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.

[in, optional] pszAttributeName

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém o nome do atributo específico para o qual recuperar dados de replicação.

Esse parâmetro só será usado se o parâmetro InfoType contiver um dos valores a seguir.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

[in, optional] pszValue

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém o valor de nome diferenciado a ser correspondido. Se o atributo solicitado for um valor de tipo de nome distinto, essa função retornará os atributos que contêm o valor especificado.

[in] dwFlags

Contém um conjunto de sinalizadores que modificam o comportamento da função. Esse parâmetro pode ser zero ou o valor a seguir.

DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS

Faz com que os metadados do atributo contabilizem metadados nos valores vinculados do atributo. O vetor resultante representa alterações para todos os atributos. Esse vetor modificado é útil para clientes que esperam que todos os atributos e metadados sejam incluídos no vetor de metadados de atributo.

[in] dwEnumerationContext

Contém o índice da próxima entrada a ser recuperada. Esse parâmetro deve ser definido como zero na primeira vez que essa função for chamada.

Esse parâmetro só será usado se o parâmetro InfoType contiver um dos valores a seguir.

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

Essa função recuperará no máximo 1000 entradas em cada chamada. Se, depois de chamar essa função, mais entradas estiverem disponíveis, o membro dwEnumerationContext da estrutura recuperada conterá o índice da próxima entrada a ser recuperada. O membro dwEnumerationContext da estrutura recuperada é usado como o parâmetro dwEnumerationContext na próxima chamada para essa função. Quando todas as entradas tiverem sido recuperadas, o membro dwEnumerationContext da estrutura recuperada conterá -1. Se -1 for passado para esse parâmetro, essa função retornará ERROR_NO_MORE_ITEMS.

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

Confira também

Funções de gerenciamento de replicação e controlador de domínio

DsBind

DsReplicaFreeInfo