libssh2_channel_process_startup(3)

✨ libssh2_channel_process_startup ✨

okay bestie, welcome to the libssh2 manual, page libssh2_channel_process_startup(3) 💅 this one is all about asking a channel to start up a lil process for you, and honestly? it's giving main character energy 🎀

🌸 NAME 🌸

libssh2_channel_process_startup — request a shell on a channel 🐚✨

🦋 SYNOPSIS 🦋

#include <libssh2.h>

int
libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
                                const char *request,
                                unsigned int request_len,
                                const char *message,
                                unsigned int message_len);

like. look at those params. five of them. we love a full lineup 👑

💖 DESCRIPTION 💖

so here's the tea, fr fr ☕:

• channel — the active session channel instance. this is your girl, your channel, the one doing the actual work.
• request — the type of process to startup. the SSH2 protocol currently defines shell, exec, and subsystem as the standard process services. that's the whole menu, no secret items 🍓
• request_len — the length of the request parameter.
• message — request-specific message data to include. like, the details that go with whatever request you picked.
• message_len — the length of the message parameter.

and what does it do? it initiates a request on a session type channel — like the kind you get handed back from libssh2_channel_open_ex(3) 🫶 so like, you get the channel first, and then you ask it to start something up. order matters, iykyk.

🔥 RETURN VALUE 🔥

returns 0 on success, or a negative number on failure. it also returns LIBSSH2_ERROR_EAGAIN when it would otherwise block — and yes, LIBSSH2_ERROR_EAGAIN is technically a negative number, but bestie, it is not really a failure per se 💀 it's just the vibe saying "try again later, girl."

no cap: negative does not always mean bad here. read the actual error code before you spiral 🙈

💀 ERRORS 💀

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed. the malloc girlies are struggling 😭
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket. the socket said no thank you 🫠
• LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED — that's the whole entry, bestie, the original just names it and dips. denied is denied 💅

🌈 SEE ALSO 🌈

• libssh2_channel_open_ex(3)

and that's the page!! 💜 this one comes from the libssh2 manual, version 0.15, dated 1 Jun 2007 — yeah she's an elder icon but she still slays 👑✨ mwah, go start some processes, love u 🎀🦋