diff options
author | Andreas Schneider <mail@cynapses.org> | 2009-05-04 07:02:33 +0000 |
---|---|---|
committer | Andreas Schneider <mail@cynapses.org> | 2009-05-04 07:02:33 +0000 |
commit | f40ae74f51c7f508904ec5dad48b7ea4c9cf06f6 (patch) | |
tree | 59bcb1433d4da0b36798fbd834d6013dcb0ae5d2 | |
parent | 5b547812eb7f19eb06bd9cc6c4861944e687923a (diff) | |
download | libssh-f40ae74f51c7f508904ec5dad48b7ea4c9cf06f6.tar.gz libssh-f40ae74f51c7f508904ec5dad48b7ea4c9cf06f6.tar.xz libssh-f40ae74f51c7f508904ec5dad48b7ea4c9cf06f6.zip |
Improve the docu of channel_request_env().
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@698 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r-- | libssh/channels.c | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/libssh/channels.c b/libssh/channels.c index 3821d6c2..267122ca 100644 --- a/libssh/channels.c +++ b/libssh/channels.c @@ -1237,13 +1237,18 @@ int channel_request_sftp( CHANNEL *channel){ return channel_request_subsystem(channel, "sftp"); } -/** \brief set the environement variables - * \param channel channel - * \param name name of the variable - * \param value value - * \return SSH_SUCCESS on success\n - * SSH_ERROR on error - * \warning some environement variables may be refused by security +/** + * @brief Set environement variables. + * + * @param channel The channel to set the environement variables. + * + * @param name The name of the variable. + * + * @param value The value to set. + * + * @return SSH_SUCCESS on success, SSH_ERROR on error. + * + * @warning Some environement variables may be refused by security reasons. * */ int channel_request_env(CHANNEL *channel, const char *name, const char *value) { BUFFER *buffer = NULL; @@ -1274,7 +1279,7 @@ int channel_request_env(CHANNEL *channel, const char *name, const char *value) { goto error; } - rc = channel_request(channel,"env",buffer,1); + rc = channel_request(channel, "env", buffer,1); error: buffer_free(buffer); string_free(str); |