libssh2_scp_recv(3)

💖 libssh2_scp_recv — like, the SCP file grabber (from the libssh2 manual, bestie) 💖

✨ NAME ✨

libssh2_scp_recv — bestie, this is how you request a remote file via SCP 🦋

🌸 SYNOPSIS 🌸

#include <libssh2.h>

LIBSSH2_CHANNEL *
libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);

💅 DESCRIPTION 💅

ok so first things first, no cap: this function is DEPRECATED in 1.7.0. Use the libssh2_scp_recv2(3) function instead! 🚨 like, fr fr, go use the other one, this one is giving legacy energy 💀

Now the deets on the arguments, because you deserve to know:

• session — the Session instance, aka the thing you got back from libssh2_session_init_ex(3) 🫶
• path — the full path and filename of the file you wanna transfer. That's the remote file name, bestie, not your local one ✨
• sb — gets populated with the remote file's size, mode, mtime, and atime 📋

And what does it actually do? It requests a file from the remote host via SCP. That's it, that's the whole vibe. 🌈

👑 RETURN VALUE 👑

You get a pointer to a newly allocated LIBSSH2_CHANNEL instance. Iconic. But if things go sideways you get NULL on errors 😭

💀 ERRORS 💀

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed. Not the moment, bestie 🙈
• LIBSSH2_ERROR_SCP_PROTOCOL — (the original page just lists it here with nothing else, so we're keeping it mysterious like that 🎀)
• LIBSSH2_ERROR_EAGAIN — this one's marked for non-blocking I/O but the call would block. So like, try again later, periodt ⭐

🦋 SEE ALSO 🦋

• libssh2_session_init_ex(3)
• libssh2_channel_open_ex(3)

and that's the whole page, bestie!! this was libssh2 version 0.15, dated 1 Jun 2007 — yes, an elder, but still serving 🌸 go forth and libssh2_scp_recv2(3) instead, mwah 💜💅