Series 300 and 800 Only

NAME

XHPPixmapToFile - Save the contents of a rectangular pixmap area in a file. 

SYNOPSIS

XHPPixmapToFile (display, pixmap, color_w, x, y, width, height, plane_mask, format, filename)
Display∗display;
Pixmappixmap;
Windowcolor_w;
intx,y;
        unsigned intwidth, height;
longplane_mask;
intformat;
char∗filename;

ARGUMENTS

display Specifies the connection to the X server. 

pixmap Specifies the pixmap ID of the image to be saved. 

color_w Specifies a window ID. This window’s colormap will be saved in the image file. Visual attributes associated with this window are used in constructing the image file header. 

x, y Specifies the x and y coordinates.  These coordinates define the upper left corner of the rectangle and are relative to the origin of the drawable. 

width, height Specifies the width and height of the subimage. These arguments define the dimensions of the rectangle. 

plane_mask Specifies the plane mask. 

format Specifies the format for the image. You can pass XYPixmap or ZPixmap. 

filename Specifies the file name to use. The format of the file name is operating system specific. 

DESCRIPTION

The XHPPixmapToFile function is similar to XHPWindowToFile but requires an additional parameter to specify the color map to be stored with the image. If the color_w parameter is zero, the root window associated with the pixmap is used to derive visual attributes and the colormap which get stored in the image file. 

RETURN VALUE

The XHPPixmapToFile function returns one of the following values defined in /usr/include/X11/XHPImageIO.h:

XHPIFSuccess Successful completion. 

XHPIFDrawableErr Couldn’t get drawable attributes or geometry. 

XHPIFFileErr Problem accessing file. 

XHPIFRequestErr Bad placement or size. 

XHPIFAllocErr Memory allocation failure. 

FILES

none

ORIGIN

Hewlett-Packard Company

SEE ALSO

XHPFileToWindow(3X), XHPFileToPixmap(3X), XHPQueryImageFile(3X), XHPWindowToFile(3x)