path: root/doc
diff options
authorDavide \"FunkyAss\" Del Zompo <davide.delzompo@gmail.com>2014-12-01 19:33:27 +0100
committerAndreas Schneider <asn@cryptomilk.org>2014-12-05 11:09:00 +0100
commitbb197de75dc283eb0047e16f107c2441e957ea4f (patch)
treeee385fed3f08021a643ad556c7a82e4ea8d15912 /doc
parent03095f1516b7f5b8b0d55f05fa9a39bae68ee8fe (diff)
doc: clarify tutorial error section
Signed-off-by: Davide "FunkyAss" Del Zompo <davide.delzompo@gmail.com> Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'doc')
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/guided_tour.dox b/doc/guided_tour.dox
index 2fa906e0..ecd637e1 100644
--- a/doc/guided_tour.dox
+++ b/doc/guided_tour.dox
@@ -443,11 +443,10 @@ Most of time, the error returned are SSH_FATAL, but some functions
(generaly the ssh_request_xxx ones) may fail because of server denying request.
In these cases, SSH_REQUEST_DENIED is returned.
-ssh_get_error() and ssh_get_error_code() take a ssh_session as a parameter.
-That's for thread safety, error messages that can be attached to a session
-aren't static anymore. Any error that happens during ssh_options_xxx()
-or ssh_connect() (i.e., outside of any session) can be retrieved by
-giving NULL as argument.
+For thread safety, errors are bound to ssh_session objects.
+As long as your ssh_session object is not NULL, you can retrieve the last error
+message and error code from the ssh_session using ssh_get_error() and
+ssh_get_error_code() respectively.
The SFTP subsystem has its own error codes, in addition to libssh ones.