libssh2_channel_get_exit_status(3)

💖 libssh2_channel_get_exit_status — get the remote exit code ✨

okay bestie, this one's from the libssh2 manual, and it's short but it's important, so stay with me 🫶

🌸 NAME 🌸

libssh2_channel_get_exit_status — bestie, it gets the remote exit code. that's the whole job. iconic behavior honestly 💅

✨ SYNOPSIS ✨

#include <libssh2.h>

int
libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)

🦋 DESCRIPTION 🦋

• channel — a closed channel stream, and you're pulling the exit status out of it. that's the vibe, that's the assignment 🎀

so what does it actually do? it returns the exit code that the process on the remote host raised — like, the thing running on the other end of the named channel. remote process said "i'm done and here's my number," and this function goes and fetches that number for you. main character energy fr fr 🔥

⚠️ but listen, this is the important bit: the exit status might not be available if the remote end has not yet set its status to closed. so if you call this too early and get nothing useful, that's not a bug, that's just the remote end not being done yet. vibe check failed, try again later 😭

👑 RETURN VALUE 👑

• returns 0 on failure — yeah, 0, which is lowkey cursed because 0 is usually the happy number, but here it means it didn't work 🙈
• otherwise, it returns the Exit Status reported by the remote host ⭐

so like, real talk: don't read 0 as "everything succeeded," read it as "bestie we got nothing." the actual remote exit code is the thing you want, and it shows up in the "otherwise" case 💜

and that's the whole page, no cap 🌈

signing off with the deets: this page belongs to libssh2 0.15, dated 1 Jun 2007, and the manual name is libssh2_channel_get_exit_status(3) 🎀 bye bestie, go read those exit codes 💖✨🦋