Copyright (C) 1989-95 GROUPE BULL

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
GROUPE BULL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of GROUPE BULL shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from GROUPE BULL.

XpmCreateData __libmansuffix__ __xorgversion__ "libXpm functions"
NAME
XpmCreateData - create an Data structure
SYNOPSIS

"int XpmCreateDataFromImage(Display *" display ", char ***" data_return , "XImage *" image ", XImage *" shapeimage ", XpmAttributes *" attributes );

"int XpmCreateDataFromPixmap(Display *" display ", char ***" data_return , "Pixmap " pixmap ", Pixmap " shapemask ", XpmAttributes *" attributes );

"int XpmCreateDataFromXpmImage(char ***" data_return ", XpmImage *" image , "XpmInfo *" info );

ARGUMENTS
display li
Specifies the connection to the X server.
data_return li
Returns the data which is created.
pixmap li
Specifies the pixmap.
shapemask li
Specifies the shape mask pixmap.
attributes li
Specifies the location of a structure containing information (or NULL).
info li
Specifies the location of a structure to get information.
image li
Specifies the image
DESCRIPTION
XpmCreateDataFromImage

In some cases, one may want to create an XPM data from an XImage, to do so use XpmCreateDataFromImage (). The XpmCreateDataFromImage () function exactly works as XpmWriteFileFromImage (__libmansuffix__) does and returns the same way. It just writes to a single block malloc’ed data instead of to a file. It is the caller’s responsibility to free the data, using XpmFree (__libmansuffix__) when finished.

XpmCreateDataFromPixmap

XpmCreateDataFromPixmap () creates an XPM data from a Pixmap. The XpmCreateDataFromPixmap () function uses XGetImage (__libmansuffix__) to get from the given pixmaps the related X images which are passed to XpmCreateDataFromImage (). Then it destroys the created images using XDestroyImage (__libmansuffix__). XpmCreateDataFromPixmap () returns the same errors as XpmCreateDataFromImage ().

XpmCreateDataFromXpmImage

XpmCreateDataFromXpmImage () creates an XPM data from an XpmImage. The XpmCreateDataFromXpmImage () function writes out the given image to a single block malloc’ed data in XPM format. If insufficient working storage is allocated, it returns XpmNoMemory , and returns XpmSuccess on success. If the passed XpmInfo structure pointer is not NULL, XpmCreateDataFromXpmImage () looks for the following attributes: XpmExtensions, and XpmHotspot, and writes the related information out as well. It is the caller’s responsibility to free the data, using XpmFree (__libmansuffix__) when finished.

"SEE ALSO"
XpmFree (__libmansuffix__), XpmWriteFileFromImage (__libmansuffix__)