XpPutDocumentData(3Xp)

💖 XpPutDocumentData 💖

okay so bestie, welcome to the 3Xp page from XPRINT FUNCTIONS. this is the whole XpPutDocumentData story, and it’s giving “send data and incorporate it into the output” main character energy. 🫶 no cap, every detail is still here.

---

🎀 NAME 🎀

void XpPutDocumentData - Sends and incorporates data into the output.

---

✨ SYNOPSIS ✨

bestie, the compile-and-call vibe is literally this:

             cc [ flag... ] file... -lXp [ library... ]
             #include <X11/extensions/Print.h>

       XpPutDocumentData ( display, drawable, data, data_len, doc_fmt, options
       )
             Display *display;
             Drawable drawable;
             unsigned char *data;
             int data_len;
             char *doc_fmt;
             char *options;

---

🫶 ARGUMENTS 🫶

• display — a pointer to the Display structure; you get it back from XOpenDisplay. iconic little handoff, honestly.
• drawable — the destination drawable for rendering. that’s where the output energy goes.
• data — the device-specific data being sent. yes, this is the actual payload.
• data_len — the number of bytes in data.
• doc_fmt — the type of data sent. peek below for valid values. string limited to XPCS characters.
• options — DDX driver dependent options. string limited to XPCS characters.

---

💅 DESCRIPTION 💅

Depending on the type for XpStartDoc, XpPutDocumentData has two modes of operation. periodt.

In XPDocRaw mode, XpPutDocumentData sends data directly to the output, and drawable must be None — else a BadDrawable error is generated. 🚨

🚨 raw-mode vibe check: bestie, drawable MUST be None. not optional. not a suggestion.

The X Print Server does not emit document or page control codes into the output, and data is passed through unmodified. This is useful for sending previously constructed and completed documents using the X Print Server job control and submission capabilities.

The printer attribute xp-raw-formats-supported defines the valid values for doc_fmt in this mode. Unsupported values for doc_fmt cause a BadMatch error to be generated.

In XPDocNormal mode, XpPutDocumentData sends data to the X Print Server, and depending on the DDX driver implementation, integrates data into the output. The parameters doc_fmt and options describe the format of data, which guides the DDX driver in interpreting data.

The printer attribute xp-embedded-formats-supported defines the valid values for doc_fmt in this mode, with unsupported values for doc_fmt causing a BadMatch error to be generated.

If doc_fmt is not in either xp-raw-formats-supported or xp-embedded-formats-supported a BadValue error is generated. 💀

Depending on the DDX driver implementation in use, XpPutDocumentData might be used, for example, to send a simple text file to a Postscript DDX driver that is capable of wrapping the appropriate document and page control constructs around the text so that it can be printed on a Postscript printer. Likewise, Encapsulated Postscript Files might be handled. Another use could be to send a TIFF file to a PCL DDX driver that can convert the image from TIFF into PCL and then integrate it into the current PCL output. it’s giving format glow-up, honestly.

There is no limit to the value of data_len. XpPutDocumentData automatically decomposes the call into multiple protocol requests to make sure that the maximum request size of the server is not exceeded. 🦋

---

🚨 DIAGNOSTICS 🚨

• BadDrawable — The value specified for drawable is not valid.
• BadMatch — The value specified for doc_fmt is not valid for the current document type or the value specified for is not valid for the print context and print screen.
• BadValue — The value specified for doc_fmt is not supported.
• XPBadContext — A valid print context-id has not been set prior to making this call.
• XPBadSequence — The function was not called in the proper order with respect to the other X Print Service Extension calls (for example, XpPutDocumentData prior to XpStartDoc).

---

👀 SEE ALSO 👀

• XpStartDoc(3Xp) — the see-also bestie. obviously.

---

💖 okay that’s the whole page, bestie. cute little sign-off: X Version 11, libXp 1.0.4 — and yes, the page title energy is XpPutDocumentData(3Xp). periodt. 🫶