XMCLIPBOARDCOPYBYNAME(3)

💖 XmClipboardCopyByName — the library call glow-up 💖

okay bestie, sit down, hydrate, and let me tell you about XmClipboardCopyByName from section 3 of the library manual, because this little function is lowkey the backstage pass of the Motif clipboard world 🎀

✨ NAME ✨

XmClipboardCopyByName — a clipboard function that copies a data item passed by name 💅

🌸 SYNOPSIS 🌸

#include <Xm/CutPaste.h>
int XmClipboardCopyByName (display, window, data_id,
        buffer, length, private_id)
        Display * display;
        Window  window;
        long    data_id;
        XtPointer       buffer;
        unsigned long   length;
        long    private_id;
(void)

🦋 DESCRIPTION 🦋

so here's the tea ☕ XmClipboardCopyByName copies the actual data for a data item that was previously passed by name to the clipboard. and when do you count as "passed by name"? it's giving: when a call to XmClipboardCopy was made with a NULL buffer parameter. that's the moment the clipboard was like "okay noted, name only, no data yet" 📝

and then — plot twist — if you call this function again and again, those additional calls append new data to the existing data. it just keeps stacking, no cap. ✨

• 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 grab that widget's window ID through XtWindow. and listen: the same application instance should pass the same window ID to every clipboard function it calls. consistency is the vibe, fr fr. 🫶
• data_id — Specifies an identifying number assigned to the data item that uniquely identifies the data item and the format. this number was handed out by XmClipboardCopy to the data item. it's basically the item's little passport 🛂
• buffer — Specifies the buffer from which the clipboard copies the data. 📦
• length — Specifies the number of bytes in the data item. numbers bestie, exact numbers 🔢
• private_id — Specifies the private data that the application wants to store with the data item. yes queen, stash your little secrets with it 🙈

💀 RETURN 💀

• XmClipboardSuccess — The function was successful. slay! 🎉✨
• XmClipboardLocked — The function failed because the clipboard was locked by another application. 😭 and the move here? the application can continue to call the function again with the same parameters until the lock goes away. this gives the application the opportunity to ask if the user wants to keep trying or to give up on the operation. so like, politely knock again, or let the user decide. no forcing the lock, we're not that girl 💅

🌈 RELATED 🌈

• XmClipboardCopy(3)
• XmClipboardLock(3)
• XmClipboardStartCopy(3)
• XmClipboardUnlock(3)

and that's the whole page, bestie 💖 this was XmClipboardCopyByName(library call) — the manual name, the source/version, and the date all live on that footer line, so consider this your cute little sign-off from the library call section, periodt. 🎀✨🦋