função ldap_get_option (winldap.h)

Artigo
08/27/2023

A função ldap_get_option recupera os valores atuais dos parâmetros de toda a sessão.

Sintaxe

WINLDAPAPI ULONG LDAPAPI ldap_get_option(
  [in]  LDAP *ld,
  [in]  int  option,
  [out] void *outvalue
);

Parâmetros

[in] ld

O identificador de sessão.

[in] option

O nome da opção acessada. Para obter mais informações e uma lista de opções permitidas e seus valores, consulte a seção Comentários a seguir.

[out] outvalue

O endereço do valor da opção. O tipo real desse parâmetro depende da configuração do parâmetro option.

Valor retornado

Se a função for bem-sucedida, o valor retornado será LDAP_SUCCESS.

Se a função falhar, será exibido um código de erro. Para obter mais informações, consulte Valores retornados.

Comentários

Para obter mais informações e uma descrição das configurações opcionais que se aplicam a uma sessão LDAP, consulte Opções de sessão. O valor outvalue retorna um ponteiro para um bloco alocado de memória do tipo listado na tabela Opções de Sessão ; essa memória deve ser liberada usando ldap_memfree quando os dados não forem mais necessários, a menos que sejam mencionados explicitamente na tabela Opções de Sessão para não liberar a memória retornada.

ObserveLDAP_OPT_ERROR_STRING retorna um ponteiro para uma tabela de cadeia de caracteres estática interna e ldap_memfree não deve ser chamado ao usar essa opção de sessão.

Multithreading: a função ldap_get_option é thread-safe.

Requisitos


Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	winldap.h
Biblioteca	Wldap32.lib
DLL	Wldap32.dll