---
name: "XpPutDocumentData"
section: "3"
platform: "linux"
package: "libxp"
version: "1.0.4-3"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/XpPutDocumentData"
---

# XpPutDocumentData(3)

Sends and incorporates data into the output.

## NAME

void XpPutDocumentData - Sends and incorporates data into the output.

## SYNOPSIS

      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*

  Specifies a pointer to the Display structure; returned from XOpenDisplay.

- *drawable*

  Specifies the destination drawable for rendering.

- *data*

  Specifies the device-specific data sent.

- *data\_len*

  Specifies the number of bytes in data.

- *doc\_fmt*

  Specifies the type of data sent. See below for valid values. String limited to XPCS characters.

- *options*

  Specifies DDX driver dependent options.   String limited to XPCS characters.

## DESCRIPTION

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

In XPDocRaw mode, XpPutDocumentData sends *data* directly to the output, and *drawable* must be None, else a BadDrawable error is generated. 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.

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)