XSetFontPath(3X11)

Name

XSetFontPath, XGetFontPath, XFreeFontPath − set, get, or free the font search path

Syntax

XSetFontPath(display, directories, ndirs)
      Display *display;
      char **directories;
      int ndirs;

char **XGetFontPath(display, npaths_return)
Display *display;
int *npaths_return;

XFreeFontPath(list)
char **list;

Arguments

directoriesSpecifies the directory path used to look for a font. Setting the path to the empty list restores the default path defined for the X server.

displaySpecifies the connection to the X server.

listSpecifies the array of strings you want to free.

ndirsSpecifies the number of directories in the path.

npaths_return
Returns the number of strings in the font path array.

Description

The XSetFontPath function defines the directory search path for font lookup. There is only one search path per X server, not one per client. The interpretation of the strings is operating system dependent, but they are intended to specify directories to be searched in the order listed. Also, the contents of these strings are operating system dependent and are not intended to be used by client applications. Usually, the X server is free to cache font information internally rather than having to read fonts from files. In addition, the X server is guaranteed to flush all cached information about fonts for which there currently are no explicit resource IDs allocated. The meaning of an error from this request is operating system dependent.

XSetFontPath can generate a BadValue error.

The XGetFontPath function allocates and returns an array of strings containing the search path. When it is no longer needed, the data in the font path should be freed by using XFreeFontPath.

The XFreeFontPath function frees the data allocated by XGetFontPath.

Diagnostics

BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument’s type is accepted. Any argument defined as a set of alternatives can generate this error.

Museum