database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-24 10:47:04 +03:00
Code

doc: Update PQgetssl() documentation

Browse Source 
The return type of PQgetssl() was changed from SSL* to void* a long time
ago, but the documentation was not updated.
This commit is contained in:
Peter Eisentraut 2013-04-16 21:42:10 -04:00
parent d61dddba37
commit b9bdaf3964
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/src/sgml/libpq.sgml
View File

@ -1864,7 +1864,7 @@ int PQconnectionUsedPassword(const PGconn *conn);
if SSL is not in use. if SSL is not in use.
<synopsis> <synopsis>
SSL *PQgetssl(const PGconn *conn); void *PQgetssl(const PGconn *conn);
</synopsis> </synopsis>
</para> </para>
@ -1875,10 +1875,29 @@ SSL *PQgetssl(const PGconn *conn);
</para> </para>
<para> <para>
You must define <symbol>USE_SSL</symbol> in order to get the The actual return value is of type <type>SSL *</type>,
correct prototype for this function. Doing so will also where <type>SSL</type> is a type defined by
automatically include <filename>ssl.h</filename> from the <productname>OpenSSL</productname> library, but it is not declared
<productname>OpenSSL</productname>. this way to avoid requiring the <productname>OpenSSL</productname>
header files. To use this function, code along the following lines
could be used:
<programlisting><![CDATA[
#include <libpq-fe.h>
#include <openssl/ssl.h>
...
SSL *ssl;
dbconn = PQconnectdb(...);
...
ssl = PQgetssl(dbconn);
if (ssl)
{
/* use OpenSSL functions to access ssl */
}
]]></programlisting>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>