diff options
Diffstat (limited to 'man/XpmMisc.man')
| -rw-r--r-- | man/XpmMisc.man | 122 |
1 files changed, 84 insertions, 38 deletions
diff --git a/man/XpmMisc.man b/man/XpmMisc.man index 7e3d696..769a9b8 100644 --- a/man/XpmMisc.man +++ b/man/XpmMisc.man @@ -26,24 +26,24 @@ .SH NAME XpmMisc \- xpm misc functions to free used memory and handle errors .SH SYNOPSIS - +.nf .HP -int XpmFreeXpmImage(XpmImage *image); +.BI "int XpmFreeXpmImage(XpmImage *" image ); .HP -int XpmFreeXpmInfo(XpmInfo *info); +.BI "int XpmFreeXpmInfo(XpmInfo *" info ); .HP -int XpmFreeAttributes(XpmAttributes *attributes); +.BI "int XpmFreeAttributes(XpmAttributes *" attributes ); .HP -int XpmAttributesSize(); +.B "int XpmAttributesSize(void);" .HP -int XpmFreeExtensions(XpmExtension *extensions, int nextensions); +.BI "int XpmFreeExtensions(XpmExtension *" extensions ", int " nextensions ); .HP -int XpmFree(char *ptr); +.BI "int XpmFree(char *" ptr ); .HP -char *XpmGetErrorString(int errorcode); +.BI "char *XpmGetErrorString(int " errorcode ); .HP -int XpmLibraryVersion(); - +.B "int XpmLibraryVersion(void);" +.fi .SH ARGUMENTS .IP \fIimage\fP li @@ -62,41 +62,87 @@ Specifies the number of extensions Specifies the structure to free .SH DESCRIPTION +.PP +To free possible data stored into an XpmImage structure use +.BR XpmFreeXpmImage (). +The +.BR XpmFreeXpmImage () +function frees the structure members which are not NULL, +but not the structure itself. +.PP +To free possible data stored into an XpmInfo structure use +.BR XpmFreeXpmInfo(). +.PP +To free data possibly stored into an array of XpmExtension use +.BR XpmFreeExtensions (). +.PP +To free any data allocated by an XPM function use the +.BR XpmFree () +function. +The current distribution of the XPM library uses the standard memory allocation +functions and thus +.BR XpmFree () +is nothing else than a define to the standard +.BR free (__libmansuffix__). +However since these functions may be redefined in specific environments +it is wise to use +.BR XpmFree () +.PP +To free possible data stored into an XpmAttributes structure use +.BR XpmFreeAttributes (). +The +.BR XpmFreeAttributes () +function frees the structure members which have been malloc’ed +such as the pixels list. +.PP +To dynamically allocate an XpmAttributes structure use the +.BR XpmAttributesSize () +function. +The +.BR XpmAttributesSize () +function provides applications using dynamic libraries with a safe way to +allocate and then refer to an XpmAttributes structure, disregarding whether +the XpmAttributes structure size has changed or not since compiled. +.PP +To get data when building an error message, one can use +.BR XpmGetErrorString (). +.BR XpmGetErrorString () +returns a string related to the given XPM error code. +.PP +The +.BR XpmLibraryVersion () +function can be used when one needs to figure out which version of the library +is in use. +The value returned by +.BR XpmLibraryVersion () +can be compared to the value of +.B XpmIncludeVersion +which is defined in the header file "xpm.h". +These numbers are computed with the following formula: -To free possible data stored into an XpmImage structure use XpmFreeXpmImage. -The XpmFreeXpmImage function frees the structure members which are not NULL, but not the structure itself. -To free possible data stored into an XpmInfo structure use XpmFreeXpmInfo. - -To free data possibly stored into an array of XpmExtension use XpmFreeExtensions. - -To free any data allocated by an XPM function use the XpmFree function. -The current distribution of the XPM library uses the standard memory allocation functions and thus -XpmFree is nothing else than a define to the standard free. -However since these functions may be redefined in specific environments it is wise to use XpmFree. - -To free possible data stored into an XpmAttributes structure use XpmFreeAttributes. -The XpmFreeAttributes function frees the structure members which have been malloc’ed such as the pixels list. - -To dynamically allocate an XpmAttributes structure use the XpmAttributesSize function. -The XpmAttributesSize function provides application using dynamic libraries with a safe way to allocate and then -refer to an XpmAttributes structure, disregarding whether the XpmAttributes structure size has changed or not since -compiled. -To get data when building an error message, one can use XpmGetErrorString. -XpmGetErrorString returns a string related to the given XPM error code. - -The XpmLibraryVersion function can be used when one needs to figure out which version of the library is in use. -The value returned by XpmLibraryVersion can be compared to the value of XpmIncludeVersion which is defined -in the header file "xpm.h". These numbers are computed with the following formula: .nf (XpmFormat * 100 + XpmVersion) * 100 + XpmRevision .fi -Where XpmFormat is the version number of the format, XpmVersion is the library version number (which changes -only if the API changes), and XpmRevision is the library minor version number. -The XpmFreeExtensions function frees all data stored in every extension and the array itself. -Note that XpmFreeAttributes call this function and thus most of the time it should not need to be explicitly called. +where +.B XpmFormat +is the version number of the format, +.B XpmVersion +is the library version number (which changes only if the API changes), and +.B XpmRevision +is the library minor version number. +.PP +The +.BR XpmFreeExtensions () +function frees all data stored in every extension and the array itself. +Note that +.BR XpmFreeAttributes () +calls this function and thus most of the time it should not need to be +explicitly called. .SH "SEE ALSO" +.ad l +.nh .BR XpmCreateBuffer (__libmansuffix__), .BR XpmCreateData (__libmansuffix__), .BR XpmCreateImage (__libmansuffix__), |