Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_sftp_shutdown (3ssh2)

Name

libssh2_sftp_shutdown - shut down an SFTP session

Synopsis

#include <libssh2.h> #include <libssh2_sftp.h>

int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);

Description

libssh2 manual                                    libssh2_sftp_shutdown(3ssh2)



NAME
       libssh2_sftp_shutdown - shut down an SFTP session

SYNOPSIS
       #include <libssh2.h> #include <libssh2_sftp.h>

       int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);


DESCRIPTION
       sftp - SFTP instance as returned by libssh2_sftp_init(3)

       Destroys  a previously initialized SFTP session and frees all resources
       associated with it.


RETURN VALUE
       Return  0  on  success  or  negative  on  failure.   It  returns   LIB-
       SSH2_ERROR_EAGAIN   when   it   would   otherwise   block.  While  LIB-
       SSH2_ERROR_EAGAIN is a negative number, it isn't really a  failure  per
       se.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_sftp_init(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.15                      1 Jun 2007
                                                  libssh2_sftp_shutdown(3ssh2)