Name

libssh2_sftp_close_handle - close filehandle

Synopsis

#include <libssh2.h>
#include <libssh2_sftp.h>
 
int
libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
 
int
libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
 
int
libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);

Description

handle - SFTP File Handle as returned by libssh2_sftp_open_ex or libssh2_sftp_opendir (which is a macro).

Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the same underlying storage mechanism these methods may be used interchangeably. libssh2_sftp_close and libssh2_sftp_closedir are macros for libssh2_sftp_close_handle.

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.

Errors

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

LIBSSH2_ERROR_SOCKET_TIMEOUT -

LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server.

See also

libssh2_sftp_open_ex

This HTML page was made with roffit.