libssh2/docs/libssh2_sftp_shutdown.md

c, SPDX-License-Identifier, Title, Section, Source, See-also

c	SPDX-License-Identifier	Title	Section	Source	See-also
Copyright (C) The libssh2 project and its contributors.	BSD-3-Clause	libssh2_sftp_shutdown	3	libssh2	libssh2_sftp_init(3)

NAME

libssh2_sftp_shutdown - shut down an SFTP session

SYNOPSIS

#include <libssh2.h>
#include <libssh2_sftp.h>

int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);

DESCRIPTION

sftp - SFTP instance as returned by libssh2_sftp_init(3)

Destroys a previously initialized SFTP session and frees all resources associated with it.

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.