libssh2_channel_request_pty_ex(3)

💖 libssh2_channel_request_pty_ex(3) 💖

okay bestie, welcome to the libssh2 manual, this one's about libssh2_channel_request_pty_ex — the "pls give me a terminal on this channel" function 🎀

✨ NAME ✨

libssh2_channel_request_pty_ex — short function description 🫶

🌸 SYNOPSIS 🌸

#include <libssh2.h>

int
libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term,
                               unsigned int term_len,
                               const char *modes, unsigned int modes_len,
                               int width, int height,
                               int width_px, int height_px);

int
libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term);

🦋 DESCRIPTION 🦋

no cap, here's the tea on every single argument 👇

• channel — a previously opened channel instance, like the one you got back from libssh2_channel_open_ex(3) ✨
• term — the terminal emulation (e.g. vt102, ansi, etc...) 👑
• term_len — length of the term parameter
• modes — terminal mode modifier values 💅
• modes_len — length of the modes parameter
• width — width of the pty in characters
• height — height of the pty in characters
• width_px — width of the pty in pixels
• height_px — height of the pty in pixels

so what does it actually do? it requests a PTY on an established channel. main character move, truly 💜

but lowkey — heads up — this does not make sense for all channel types, and the server may just ignore it entirely despite returning success 😭 like it'll say "sure babe" and then do nothing. rude but real.

🔥 RETURN VALUE 🔥

returns 0 on success, or negative on failure. it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block.

and listen, while LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se — it's giving "not right now, try again" energy, not "everything is on fire" energy 💀

🌈 ERRORS 🌈

• LIBSSH2_ERROR_ALLOC — an internal memory allocation call failed 😭
• LIBSSH2_ERROR_SOCKET_SEND — unable to send data on socket 🫠
• LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED — (that's all the page says, bestie, no extra notes 💅)

👑 SEE ALSO 👑

• libssh2_channel_open_ex(3)

and that's the whole vibe check, bestie ✨ this page came from libssh2 0.15, dated 1 Jun 2007 — yeah she's vintage, she's iconic, she ate and left no crumbs 💖 mwah, go request that pty 🎀🦋