GUAC-1389: Document VNC password retrieval.

This commit is contained in:
Michael Jumper 2016-03-03 11:58:21 -08:00
parent d484a98876
commit 4c62b60f71

View File

@ -29,7 +29,15 @@
#include <rfb/rfbproto.h> #include <rfb/rfbproto.h>
/** /**
* Handler which returns the configured password. * Callback which is invoked by libVNCServer when it needs to read the user's
* VNC password. As ths user's password, if any, will be stored in the
* connection settings, this function does nothing more than return that value.
*
* @param client
* The rfbClient associated with the VNC connection requiring the password.
*
* @return
* The password to provide to the VNC server.
*/ */
char* guac_vnc_get_password(rfbClient* client); char* guac_vnc_get_password(rfbClient* client);