libssh2_session_methods.3: detail what can be asked for

This commit is contained in:
Daniel Stenberg 2010-10-10 23:51:22 +02:00
parent 77a9335515
commit c36f379b88

View File

@ -13,17 +13,17 @@ libssh2_session_methods(LIBSSH2_SESSION *session, int method_type);
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)
\fImethod_type\fP - One of the Method Type constants. \fImethod_type\fP - one of the method type constants: LIBSSH2_METHOD_KEX,
LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC,
Return the actual method negotiated for a particular transport parameter. LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS,
LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC.
Returns the actual method negotiated for a particular transport parameter.
.SH RETURN VALUE .SH RETURN VALUE
Negotiated method or NULL if the session has not yet been started. Negotiated method or NULL if the session has not yet been started.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. \fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
\fILIBSSH2_ERROR_METHOD_NONE\fP - \fILIBSSH2_ERROR_METHOD_NONE\fP - no method has been set
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)