libssh2

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

11
int
12
libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);
13
.fi
14
.SH DESCRIPTION
15
\fIsftp\fP - SFTP instance as returned by
16
.BR libssh2_sftp_init(3)
17

18
Destroys a previously initialized SFTP session and frees all resources
19
associated with it.
20
.SH RETURN VALUE
21
Return 0 on success or negative on failure. It returns
22
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
23
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
24
.SH SEE ALSO
25
.BR libssh2_sftp_init(3)
26