libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_sftp_close_handle - close filehandle
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
int
12
libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
13

14
int
15
libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
16

17
int
18
libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);
19
.fi
20
.SH DESCRIPTION
21
\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP
22
or \fBlibssh2_sftp_opendir(3)\fP (which is a macro).
23

24
Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the
25
same underlying storage mechanism these methods may be used
26
interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP
27
are macros for \fBlibssh2_sftp_close_handle(3)\fP.
28
.SH RETURN VALUE
29
Return 0 on success or negative on failure. It returns
30
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
31
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
32
.SH ERRORS
33
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
34

35
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
36

37
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
38

39
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
40
received on the socket, or an SFTP operation caused an errorcode to
41
be returned by the server.
42
.SH SEE ALSO
43
.BR libssh2_sftp_open_ex(3)
44