libssh2_sftp_unlink_ex(3)

✨ libssh2_sftp_unlink_ex ✨

okay so bestie, welcome to the libssh2 manual, page libssh2_sftp_unlink_ex(3) 💅 this one is short and sweet and it's giving "delete that file, bestie" energy 🗑️✨

🌸 NAME 🌸

libssh2_sftp_unlink_ex — unlink an SFTP file 🫶

🦋 SYNOPSIS 🦋

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

int
libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len);

int
libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename);

two icons, one job 😌 the _ex one lets you pass the length yourself, the other one figures it out. slay.

🎀 DESCRIPTION 🎀

• sftp — the SFTP instance, as returned by libssh2_sftp_init(3) 🌈
• filename — path and name of the existing filesystem entry 🍓
• filename_len — length of the path and name of the existing filesystem entry 📏

and what does it do? it unlinks (deletes) a file from the remote filesystem. that's it. that's the whole vibe. poof, gone, no cap 💀✨

fr fr bestie, "unlink" means delete. once it's gone it's gone, so maybe do a vibe check on that path before you send it 👀

💖 RETURN VALUE 💖

returns 0 on success, or a negative number on failure 😭 and heads up: it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. and like… yes, LIBSSH2_ERROR_EAGAIN is a negative number, but it's not really a failure per se — it's just the "not right now, try again later" of it all, iykyk 🫶

🔥 ERRORS 🔥

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed 💀
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket 📡
• LIBSSH2_ERROR_SOCKET_TIMEOUT — ⏰ (that's the whole note, bestie, the original said nothing more and we don't make things up here ✋)
• 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_init(3) 👑

mwah 💜 this page comes to you from the libssh2 0.15 era, dated 1 Jun 2007 — vintage icon behavior, honestly 👑 thanks for reading, go delete something responsibly 🎀🦋✨