diff options
author | Andreas Schneider <asn@cryptomilk.org> | 2019-08-01 17:11:34 +0200 |
---|---|---|
committer | Andreas Schneider <asn@cryptomilk.org> | 2019-11-04 09:47:02 +0100 |
commit | e5767bf0b778be4e0948de0b8e32b86a3c85460a (patch) | |
tree | 82b7e701ee8916ffb4ef28b4bd68c0f0eaa1412f /src/channels.c | |
parent | 4a113159b2f3f22f5e73d982c638c3288b24e821 (diff) | |
download | libssh-e5767bf0b778be4e0948de0b8e32b86a3c85460a.tar.gz libssh-e5767bf0b778be4e0948de0b8e32b86a3c85460a.tar.xz libssh-e5767bf0b778be4e0948de0b8e32b86a3c85460a.zip |
channel: Document ssh_channel_request_sftp()
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
Diffstat (limited to 'src/channels.c')
-rw-r--r-- | src/channels.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/channels.c b/src/channels.c index 23666137..412dd9ce 100644 --- a/src/channels.c +++ b/src/channels.c @@ -1964,6 +1964,18 @@ error: return rc; } +/** + * @brief Request sftp subsystem on the channel + * + * @param[in] channel The channel to request the sftp subsystem. + * + * @return SSH_OK on success, + * SSH_ERROR if an error occurred, + * SSH_AGAIN if in nonblocking mode and call has + * to be done again. + * + * @note You should use sftp_new() which does this for you. + */ int ssh_channel_request_sftp( ssh_channel channel){ if(channel == NULL) { return SSH_ERROR; |