función ldap_get_option (winldap.h)

Artículo
03/08/2023

La función ldap_get_option recupera los valores actuales de los parámetros de toda la sesión.

Sintaxis

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

Parámetros

[in] ld

Identificador de sesión.

[in] option

Nombre de la opción a la que se tiene acceso. Para obtener más información y una lista de opciones permitidas y sus valores, vea la siguiente sección Comentarios.

[out] outvalue

Dirección del valor de opción. El tipo real de este parámetro depende de la configuración del parámetro de opción.

Valor devuelto

Si la función se ejecuta correctamente, se LDAP_SUCCESS el valor devuelto.

Si la función presenta un error, devuelve un código de error. Para obtener más información, vea Valores devueltos.

Comentarios

Para obtener más información y una descripción de la configuración opcional que se aplica a una sesión LDAP, consulte Opciones de sesión. El valor outvalue devuelve un puntero a un bloque de memoria asignado del tipo enumerado en la tabla Opciones de sesión ; esta memoria debe liberarse mediante ldap_memfree cuando ya no se necesiten los datos, a menos que se mencione explícitamente en la tabla Opciones de sesión para no liberar la memoria devuelta.

NotaLDAP_OPT_ERROR_STRING devuelve un puntero a una tabla de cadenas estáticas interna y no se debe llamar a ldap_memfree al usar esta opción de sesión.

Multithreading: la función ldap_get_option es segura para subprocesos.

Requisitos


Cliente mínimo compatible	Windows Vista
Servidor mínimo compatible	Windows Server 2008
Plataforma de destino	Windows
Encabezado	winldap.h
Library	Wldap32.lib
Archivo DLL	Wldap32.dll