mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-02 10:53:16 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_sftp_close_handle
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_sftp_open_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_sftp_close_handle - close filehandle
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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(3)**
|
|
or **libssh2_sftp_opendir(3)** (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(3)** and **libssh2_sftp_closedir(3)**
|
|
are macros for **libssh2_sftp_close_handle(3)**.
|
|
|
|
# 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.
|