XMPRINTTOFILE(3)

💖 NAME 💖

XmPrintToFile — the library call that grabs all the data that would normally get printed by the X Print Server and, like, saves it for you 🎀

---

✨ SYNOPSIS ✨

#include <Xm/Print.h>
XtEnumXmPrintToFile(
Display*dpy,
Stringfilename,
XPFinishProcfinish_proc,
XtPointerclient_data);

---

🦋 DESCRIPTION 🦋

okay so, XmPrintToFile is literally here to hide all the X display connection drama and the XpGetDocumentData details from you, the Motif application programmer. no cap. you don't need to know the lore, she's got it handled 💅

She's a convenience routine, bestie — the whole point is that she wraps up the X and Xp internals for you by calling the XpGetDocumentData function with the appropriate save and finish callbacks already wired in. iconic behavior, honestly.

You use this in the context of X Printing when the user has picked the "print-to-file" option from a regular Print Setup Dialog box. very demure, very mindful.

Here's the flow, and it's actually pretty simple:

• First, XmPrintToFile tries to open the given filename for writing, and if it can't, she returns False. periodt.
• Otherwise, she uses XpGetDocumentData, handing it a save proc that writes the data received into the file, plus a finish proc that closes the file — or removes it if the termination wasn't successful. 🫶
• Then she calls finish_proc right at that point, passing along the argument she got from the Xp layer. And listen: status == XPGetDocFinished means the file is valid and was closed. Anything else means the file was removed. 💀

⚠️ vibe check: XmPrintToFile is non-blocking. So if she returns successfully, that only means the file was opened successfully — it does not mean all the data has been received yet. don't get it twisted, bestie 😭

the arguments, one by one 🌈

• dpy — the Print display connection. your whole display situation.
• filename — the name of the file to put the print data in. yeah, that one.
• finish_proc — called when all the data has been received. she's the closer 💅
• client_data — passed along with the finish_proc. little gift, hand-delivered.

---

⭐ RETURN VALUE ⭐

• Returns False if filename could not be created or opened for writing.
• Returns True otherwise. slay ✨

---

🙈 ERRORS/WARNINGS 🙈

Not applicable. nothing to see here, no drama, we love a clean section 🎀

---

🔥 EXAMPLES 🔥

Here's a typical OK callback from a DtPrintSetupBox, and yes she ate:

PrintOKCallback(widget...)
/*-------------*/
{   int save_data = XPSpool;

    pshell = XmPrintSetup (widget, pbs->print_screen,
                                           "Print", NULL, 0);

    XtAddCallback(pshell, XmNstartJobCallback, startJobCB, data);

    if (pbs->destination == DtPRINT_TO_FILE)
                 save_data = XPGetData;

    /* start job must precede XpGetDocumentData in XmPrintToFile */
    XpStartJob(XtDisplay(pshell), save_data);
    XFlush(XtDisplay(pshell));  /* maintain the sequence
                                 between startjob and getdocument */

    /* setup print to file */
    if (pbs->destination == DtPRINT_TO_FILE)
        XmPrintToFile(XtDisplay(pshell),
                                 pbs->dest_info, FinishPrintToFile, NULL);
    }

}

static void
startJobCB(Widget, XtPointer call_data, XtPointer client_data)
{
  print(p);   /* rendering happens here */

  XpEndJob(XtDisplay(p->print_shell));

  /* clean up */
  XtDestroyWidget(p->print_shell);
          XtCloseDisplay(XtDisplay(p->print_shell));
}

note the little comment in there, bestie: start job must precede XpGetDocumentData in XmPrintToFile. order matters, don't freestyle it 🧚

---

👑 SEE ALSO 👑

• XmPrintSetup(3)
• XmPrintShell(3)
• XmRedisplayWidget(3)
• XmPrintPopupPDM(3)

---

and that's the whole page, babe 🦋 this was the XmPrintToFile(library call) manual page from the Motif library call docs — go forth and print to file responsibly, ily, mwah 💖🌸