UNLOCKPT(3POSIX)

📦 version 2017a, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 UNLOCKPT(3POSIX) 💖

okay bestie, welcome to the POSIX Programmer's Manual ✨ before we even start, real talk: this page lives in the POSIX Programmer's Manual, and the Linux implementation of this interface may differ (so like, go check the corresponding Linux manual page for the deets on Linux behavior, fr), or honestly the interface might not even be implemented on Linux at all. 💀

🌸 NAME 🌸

unlockpt — unlock a pseudo-terminal master/slave pair 🦋

✨ SYNOPSIS ✨

#include <stdlib.h>

int unlockpt(int fildes);

💅 DESCRIPTION 💅

so the unlockpt() function shall unlock the slave pseudo-terminal device associated with the master that fildes points to. that's it, that's the whole job. 👑

and listen, this part is important: conforming applications shall make sure they call unlockpt() before opening the slave side of a pseudo-terminal device. do not skip this step, bestie, it's giving prerequisites. 🎀

🌈 RETURN VALUE 🌈

  • upon successful completion, unlockpt() shall return 0. slay. ✅
  • otherwise it shall return -1 and set errno to indicate the error. 😭

🔥 ERRORS 🔥

the unlockpt() function may fail if:

  • EBADF — the fildes argument is not a file descriptor open for writing. like, she's not even open for business, babe. 💀
  • EINVAL — the fildes argument is not associated with a master pseudo-terminal device. wrong vibe entirely, that's not a master pty. 🙈
heads up: the following sections are informative. (translation: they're the lore, not the law. 📖)

🎀 EXAMPLES 🎀

None.

bestie there is literally nothing here. empty. void. not a single example. 😭

🦋 APPLICATION USAGE 🦋

None.

again, absolutely nothing. we love a minimal queen. 💅

💜 RATIONALE 💜

See the RATIONALE section for posix_openpt().

go read that one, the lore is over there. ✨

⭐ FUTURE DIRECTIONS ⭐

None.

the future is... empty? iconic of her honestly.

🫶 SEE ALSO 🫶

  • grantpt()
  • open()
  • posix_openpt()
  • ptsname()

and also, from the Base Definitions volume of POSIX.1‐2017: <stdlib.h> 🌸

okay so legal bit, don't skip it, it matters:

portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. in the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. the original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. to report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

and that's the whole page, bestie 🧚💖 this lil drop came to you courtesy of IEEE/The Open Group, dated 2017, under the UNLOCKPT(3POSIX) banner — mwah, go unlock some pseudo-terminals responsibly. 🍓💜

📦 where this page comes from