diff options
| author | anupamasingh10 <anupamasingh31@gmail.com> | 2023-03-10 19:25:11 +0100 |
|---|---|---|
| committer | Ingela Anderton Andin <ingela@erlang.org> | 2023-04-25 16:20:32 +0200 |
| commit | 6706de788689d4b65f2190fb047641a6d94a6131 (patch) | |
| tree | e2bce7af2c288b6042beece312498ec84d497a19 | |
| parent | 474317eeb9cf929cb6a2a0a181b0c1ced2aa034d (diff) | |
| download | erlang-6706de788689d4b65f2190fb047641a6d94a6131.tar.gz | |
Update eldap:info/1 documentation
| -rw-r--r-- | lib/eldap/doc/src/eldap.xml | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/eldap/doc/src/eldap.xml b/lib/eldap/doc/src/eldap.xml index edc308ba52..aae0f346b9 100644 --- a/lib/eldap/doc/src/eldap.xml +++ b/lib/eldap/doc/src/eldap.xml @@ -549,14 +549,15 @@ Control2 = eldap:paged_result_control(PageSize, Cookie1), </desc> </func> <func> - <name since="@OTP-XXXX@">info(Handle) -> #{socket := Socket, socket_type := tcp | ssl}</name> - <fsummary>Returns the SSL or TCP socket for LDAP connection. + <name since="@OTP-18480@">info(Handle) -> connection_info()</name> + <fsummary>Returns information about the LDAP connection. </fsummary> <type> + <v>connection_info() = #{socket := Socket, socket_type := tcp | ssl}</v> <v>Socket = ssl:sslsocket() | gen_tcp:socket()</v> </type> - <desc><p>Returns the socket type and socket for a TCP/SSL connection - to an LDAP server</p> + <desc><p>Currently available information reveals the socket and the transport + protocol, TCP or TLS (SSL), used by the LDAP connection.</p> </desc> </func> |