Add warning in channel_open_forward documentation

Tell users it does not do magic (yet)
This commit is contained in:
Aris Adamantiadis
2009-09-14 23:18:07 +02:00
parent f28352707a
commit ffca268bee

View File

@@ -672,6 +672,9 @@ int channel_open_session(ssh_channel channel) {
*
* @param localport The source port (your local computer). It's facultative
* and for logging purpose.
* @warning This function does not bind the local port and does not automatically
* forward the content of a socket to the channel. You still have to
* use channel_read and channel_write for this.
*
* @return SSH_OK on success\n
* SSH_ERROR on error