1libssh2_sftp_close_handle(3)    libssh2 manual    libssh2_sftp_close_handle(3)
2
3
4

NAME

6       libssh2_sftp_close_handle - close filehandle
7

SYNOPSIS

9       #include <libssh2.h> #include <libssh2_sftp.h>
10
11       int libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
12
13       int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
14
15       int libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);
16
17

DESCRIPTION

19       handle  -  SFTP  File  Handle as returned by libssh2_sftp_open_ex(3) or
20       libssh2_sftp_opendir(3) (which is a macro).
21
22       Close an active  LIBSSH2_SFTP_HANDLE.  Because  files  and  directories
23       share  the  same underlying storage mechanism these methods may be used
24       interchangably. libssh2_sftp_close(3) and libssh2_sftp_closedir(3)  are
25       macros for libssh2_sftp_close_handle(3).
26
27

RETURN VALUE

29       Return   0  on  success  or  negative  on  failure.   It  returns  LIB‐
30       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB‐
31       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
32       se.
33
34

ERRORS

36       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.
37
38       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
39
40       LIBSSH2_ERROR_SOCKET_TIMEOUT -
41
42       LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid  SFTP  protocol  response  was
43       received  on the socket, or an SFTP operation caused an errorcode to be
44       returned by the server.
45
46

SEE ALSO

48       libssh2_sftp_open_ex(3)
49
50
51
52libssh2 0.15                      1 Jun 2007      libssh2_sftp_close_handle(3)
Impressum