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

NAME

6       libssh2_sftp_close_handle - close filehandle
7

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUE

31       Return  0  on  success  or negative on failure.  It returns LIBSSH2_ER‐
32       ROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is
33       a negative number, it is not really a failure per se.
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 re‐
43       ceived on the socket, or an SFTP operation caused an  errorcode  to  be
44       returned by the server.
45

SEE ALSO

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