XMCLIPBOARDLOCK(3)

💖 XmClipboardLock 💖

okay bestie, welcome to the XmClipboardLock page — it's a library call, and it's literally the bouncer at the clipboard club 🫶

---

✨ NAME ✨

XmClipboardLock — a clipboard function that locks the clipboard 🔒💅

---

✨ SYNOPSIS ✨

#include <Xm/CutPaste.h>
int XmClipboardLock (display, window)
        Display * display;
        Window  window;
(void)

---

✨ DESCRIPTION ✨

okay so XmClipboardLock locks the clipboard so no other application can touch it until XmClipboardUnlock gets called. 🎀

and like, all clipboard functions lock and unlock the clipboard, because we are not doing simultaneous access in this house. this function is the one that lets your application keep the clipboard data from changing between calls to Inquire and other clipboard functions. 👑

but ngl, you do not need to lock the clipboard between calls to XmClipboardStartCopy and XmClipboardEndCopy, or between XmClipboardStartRetrieve and XmClipboardEndRetrieve. those are already handled, bestie, you can breathe. 😌

💀 if the clipboard is already locked by another application, XmClipboardLock returns an error status. and if the same application calls this function multiple times? that just increases the lock level. stacking locks, main character energy. 🧚

• display — specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. ✨
• window — specifies the window ID of a widget that relates the application window to the clipboard. you can get that widget's window ID through XtWindow. and listen — the same application instance should pass the same window ID to each of the clipboard functions that it calls. consistency is the vibe, fr fr. 🦋

---

✨ RETURN ✨

• XmClipboardSuccess — slay 💅 the function was successful.
• XmClipboardLocked — the function failed because the clipboard was locked by another application. 😭 the application can keep calling the function again with the same parameters until the lock goes away — and that's actually a feature, because it gives the application the opportunity to ask if the user wants to keep trying or to give up on the operation. your call, babe. 🫶

---

✨ RELATED ✨

the girlies you should also know about: XmClipboardEndCopy(3), XmClipboardEndRetrieve(3), XmClipboardStartCopy(3), XmClipboardStartRetrieve(3), and XmClipboardUnlock(3). go read them, iykyk 📚💖

---

and that's the whole page, bestie!! this was XmClipboardLock(library call) — yes, same name up top and down at the bottom, she contains multitudes 💜✨ go lock that clipboard, you're doing amazing, periodt. 🎀🌸