diff options
author | Andreas Schneider <mail@cynapses.org> | 2009-05-04 10:20:20 +0000 |
---|---|---|
committer | Andreas Schneider <mail@cynapses.org> | 2009-05-04 10:20:20 +0000 |
commit | 1afe6b13c5e77d01e6b198714f669752d89a8879 (patch) | |
tree | 12da70400c3ef0bd6c2e0b8f618c4c3492c4a8c9 | |
parent | 0d17b6778bc37214abab32989773cf4ce4688348 (diff) | |
download | libssh-1afe6b13c5e77d01e6b198714f669752d89a8879.tar.gz libssh-1afe6b13c5e77d01e6b198714f669752d89a8879.tar.xz libssh-1afe6b13c5e77d01e6b198714f669752d89a8879.zip |
Improve the docu of channel_get_exit_status().
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@704 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r-- | libssh/channels.c | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/libssh/channels.c b/libssh/channels.c index 47e2c97..35ef683 100644 --- a/libssh/channels.c +++ b/libssh/channels.c @@ -1633,12 +1633,14 @@ SSH_SESSION *channel_get_session(CHANNEL *channel) { return channel->session; } -/** \brief get the exit status of the channel (error code from the executed instruction). - * \param channel channel - * \return -1 no exit status was returned. - * \return other values : exit status +/** + * @brief Get the exit status of the channel (error code from the executed + * instruction). + * + * @param channel The channel to get the status from. + * + * @return -1 if no exit status has been returned, the exit status othewise. */ - int channel_get_exit_status(CHANNEL *channel) { channel_request(channel, "exit-status", NULL, 0); |