26 lines
764 B
Groff
26 lines
764 B
Groff
|
.\" Copyright (C) The libssh2 project and its contributors.
|
||
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
||
|
|
.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
||
|
|
.SH NAME
|
||
|
|
libssh2_sftp_shutdown - shut down an SFTP session
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <libssh2.h>
|
||
|
|
#include <libssh2_sftp.h>
|
||
|
|
|
||
|
|
int
|
||
|
|
libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\fIsftp\fP - SFTP instance as returned by
|
||
|
|
.BR libssh2_sftp_init(3)
|
||
|
|
|
||
|
|
Destroys a previously initialized SFTP session and frees all resources
|
||
|
|
associated with it.
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Return 0 on success or negative on failure. It returns
|
||
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR libssh2_sftp_init(3)
|