libssh2/share/man/man3/libssh2_banner_set.3

   1 .\" $Id: libssh2_banner_set.3,v 1.1 2007/06/13 17:03:38 jehousley Exp $
   2 .\"
   3 .TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_banner_set - set the SSH prococol banner for the local client
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - Session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIbanner\fP - A pointer to a user defined banner
  17
  18 Set the banner that will be sent to the remote host when the SSH session is
  19 started with
  20 .BR libssh2_session_startup(3)
  21 .  This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
  22
  23 .SH RETURN VALUE
  24 Return 0 on success or negative on failure.  It returns
  25 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  26 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  27
  28 .SH ERRORS
  29 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  30
  31 .SH SEE ALSO
  32 .BR libssh2_session_startup(3)