doc: Update PQgetssl() documentation

The return type of PQgetssl() was changed from SSL* to void* a long time
ago, but the documentation was not updated.

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 3b6ada08f7ca6c95efa4994c7c74327b0afbe193..deef3be9659d45bd310349d9fec1730e75d9b219 100644 (file)
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -1864,7 +1864,7 @@ int PQconnectionUsedPassword(const PGconn *conn);
        if SSL is not in use.
 
 
-SSL *PQgetssl(const PGconn *conn);
+void *PQgetssl(const PGconn *conn);
 
       
 
@@ -1875,10 +1875,29 @@ SSL *PQgetssl(const PGconn *conn);
       
 
       
-       You must define USE_SSL in order to get the
-       correct prototype for this function. Doing so will also
-       automatically include ssl.h from
-       OpenSSL.
+       The actual return value is of type SSL *,
+       where SSL is a type defined by
+       the OpenSSL library, but it is not declared
+       this way to avoid requiring the OpenSSL
+       header files.  To use this function, code along the following lines
+       could be used:
+
+#include 
+#include 
+
+...
+
+    SSL *ssl;
+
+    dbconn = PQconnectdb(...);
+    ...
+
+    ssl = PQgetssl(dbconn);
+    if (ssl)
+    {
+        /* use OpenSSL functions to access ssl */
+    }
+]]>