Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

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 THE X CONSORTIUM 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 the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.


XListFonts __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XListFonts, XFreeFontNames, XListFontsWithInfo, XFreeFontInfo - obtain or free font names and information
SYNTAX

char **XListFonts\^(\^Display *\^display\^, _Xconst char *\^pattern\^, int maxnames\^, int *\^actual_count_return\^);

int XFreeFontNames\^(\^char *list\^[\^]\^);

char **XListFontsWithInfo\^(\^Display *display\^, _Xconst char *pattern\^, int maxnames\^, int *count_return\^, XFontStruct **info_return\^);

int XFreeFontInfo(\^char **names\^, XFontStruct *free_info, int actual_count\^);

ARGUMENTS
actual_count 1i
Specifies the actual number of font names.
actual_count_return 1i
Returns the actual number of font names.
count_return 1i
Returns the actual number of matched font names.
display 1i
Specifies the connection to the X server.
info_return 1i
Returns the font information.
free_info 1i
Specifies the font information.
list 1i
Specifies the array of strings you want to free.
maxnames 1i
Specifies the maximum number of names to be returned.
names 1i
Specifies the list of font names.
pattern 1i
Specifies the null-terminated pattern string that can contain wildcard characters.
DESCRIPTION
The XListFonts function returns an array of available font names (as controlled by the font search path; see XSetFontPath ) that match the string you passed to the pattern argument. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, and each question mark (?) is a wildcard for a single character. If the pattern string is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. Each returned string is null-terminated. If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, XListFonts returns NULL. The client should call XFreeFontNames when finished with the result to free the memory.

The XFreeFontNames function frees the array and strings returned by XListFonts or XListFontsWithInfo .

The XListFontsWithInfo function returns a list of font names that match the specified pattern and their associated font information. The list of names is limited to size specified by maxnames. The information returned for each font is identical to what XLoadQueryFont would return except that the per-character metrics are not returned. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, and each question mark (?) is a wildcard for a single character. If the pattern string is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. Each returned string is null-terminated. If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, XListFontsWithInfo returns NULL.

To free only the allocated name array, the client should call XFreeFontNames . To free both the name array and the font information array or to free just the font information array, the client should call XFreeFontInfo .

The XFreeFontInfo function frees a font structure or an array of font structures and optionally an array of font names. If NULL is passed for names, no font names are freed. If a font structure for an open font (returned by XLoadQueryFont ) is passed, the structure is freed, but the font is not closed; use XUnloadFont to close the font.

Note that XListFontsWithInfo is not thread-safe. If other threads make X requests on the same Display , then this function's behavior is undefined.

"SEE ALSO"
XLoadFont(__libmansuffix__), XSetFontPath(__libmansuffix__)

\*(xL