função ldap_parse_vlv_controlA (winldap.h)

Artigo
11/20/2024

A função ldap_parse_vlv_control é usada para localizar e analisar os resultados da pesquisa VLV.

Sintaxe

WINLDAPAPI INT LDAPAPI ldap_parse_vlv_controlA(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPControlA *Control,
  [out] PULONG        TargetPos,
  [out] PULONG        ListCount,
  [out] PBERVAL       *Context,
  [out] PINT          ErrCode
);

Parâmetros

[in] ExternalHandle

O identificador de sessão LDAP.

[in] Control

O endereço de uma matriz terminada em NULL de estruturas de LDAPControl , normalmente obtida por uma chamada para ldap_parse_result.

[out] TargetPos

A posição numérica da entrada de destino na lista de conjuntos de resultados, conforme fornecido pelo elemento targetPosition do controle de resposta codificado por BER (LDAP_CONTROL_VLVRESPONSE). Se esse parâmetro for NULL, a posição de destino não será retornada.

[out] ListCount

A estimativa do servidor do número de entradas na lista, conforme fornecido pelo elemento contentCount do controle de resposta codificado por BER (LDAP_CONTROL_VLVRESPONSE). Se esse parâmetro for NULL, o tamanho não será retornado.

[out] Context

O identificador de contexto gerado pelo servidor. Se o servidor não retornar um identificador de contexto, esse parâmetro será definido como NULL. Se NULL for passado para contextp, o identificador de contexto não será retornado.

[out] ErrCode

O código de resultado VLV, conforme fornecido pelo elemento virtualListViewResult do controle de resposta codificado em BER (LDAP_CONTROL_VLVRESPONSE). Se esse parâmetro for NULL, o código de resultado não será retornado.

Valor de retorno

Essa função retorna um código de erro LDAP que indica se um controle de resultado VLV foi encontrado e analisado com êxito. LDAP_SUCCESS será retornado se tudo correr bem, LDAP_CONTROL_MISSING será retornado se o ctrls matriz não incluir um controle de resposta (LDAP_CONTROL_VLVRESPONSE) e outro código de erro LDAP for retornado se ocorrer um erro de análise ou outro problema.

O VLV usa os seguintes códigos de valor de retorno LDAP:

LDAP_OPERATIONS_ERROR

LDAP_UNWILLING_TO_PERFORM

LDAP_INSUFFICIENT_ACCESS

LDAP_BUSY

LDAP_TIMELIMIT_EXCEEDED

LDAP_ADMINLIMIT_EXCEEDED

LDAP_OTHER

Além disso, os dois códigos a seguir foram adicionados para dar suporte ao VLV:

Observações

Esse controle analisa os resultados da pesquisa retornados pelo servidor no controle de resposta (LDAP_CONTROL_VLVRESPONSE). Um identificador de contexto é passado do servidor para o cliente para identificar o controle, que deve ser liberado no final da sessão chamando ber_bvfree.

Para obter mais informações e um exemplo de código, consulte código de exemplo para usarLDAP VLV.

Nota

O cabeçalho winldap.h define ldap_parse_vlv_control como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	winldap.h
biblioteca	Wldap32.lib
de DLL	Wldap32.dll