libssh2_sftp_close_handle(3)

✨ libssh2_sftp_close_handle(3) ✨

okay bestie, gather round, we're closing file handles today and honestly? it's giving closure 🎀 this one lives in the libssh2 manual and it's the glow-up your SFTP session needs when you're done with it 💅

💖 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 — the SFTP File Handle, aka the little token you got handed back from libssh2_sftp_open_ex(3) or libssh2_sftp_opendir(3) (and psst, that last one is a macro 👀).

So what are we doing here? We're closing an active LIBSSH2_SFTP_HANDLE. And here's the iconic part: because files and directories share the same underlying storage mechanism, these methods are literally interchangeable, no cap. libssh2_sftp_close(3) and libssh2_sftp_closedir(3) are both macros for libssh2_sftp_close_handle(3). Same vibe, same function, three names. main character energy fr fr ✨

🔥 RETURN VALUE 🔥

• Returns 0 on success, or a negative number on failure. 💀
• It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block.

okay important: LIBSSH2_ERROR_EAGAIN is a negative number, yes, but it is not really a failure per se. It's just the function saying "not yet bestie, try again later" 😌 don't panic, it's not a real L.

😭 ERRORS 😭

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed. the malloc said no 🙈
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket. the socket is not picking up the phone 📵
• 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. server said something unhinged and we're not entertaining it 💅

👑 SEE ALSO 👑

• libssh2_sftp_open_ex(3)

and that's the whole page bestie, you ate that 🍓 go close some handles responsibly, hydrate, and remember: three names, one function, zero drama ✨

libssh2 0.15 · 1 Jun 2007 — yeah this page is vintage, it's been iconic since 2007 and it still slays 💖 mwah, bye 🫶