XGetDefault(3X11) XLIB FUNCTION XGetDefault(3X11)NAMEXGetDefault - Returns a character string corresponding to the addr
field of a resource entry
SYNOPSIS
char *XGetDefault ( display, program, option )
Display *display;
char *program;
char *option;
ARGUMENTS
- display
Specifies the connection to the X server
- program
Specifies the program name for the Xlib defaults (usually
argv[0] of the main program)
- option
Specifies the option name
DESCRIPTION
The XGetDefault function returns a character string corresponding to
the addr field of a resource entry which is of the XrmValue type. The
resource entry is retrieved from a database by calling the XrmQGetRe‐
source function. The database is referred to by the display argument
and the resource is referred to by the program and the option argu‐
ments.
The class Program.Name is always used for the resource lookup. If the
specified option name does not exist for this program, XGetDefault
returns NULL.
The strings returned by XGetDefault are owned by Xlib and should not be
modified or freed by the client.
If a database has been set with XrmSetDatabase, that database is used
for the lookup. Otherwise, a database is created and is set in the dis‐
play (as if by calling XrmSetDatabase).
The database is created in the current locale. To create a database,
XGetDefault uses resources from the RESOURCE_MANAGER property on the
root window of screen zero. If no such property exists, a resource file
in the user's home directory is used. On a POSIX-conformant system,
this file is $HOME/.Xdefaults. After loading these defaults, XGetDe‐
fault merges additional defaults specified by the XENVIRONMENT environ‐
ment variable. If XENVIRONMENT is defined, it contains a full path
name for the additional resource file. If XENVIRONMENT is not defined,
XGetDefault looks for $HOME/.Xdefaults-name, where name specifies the
name of the machine on which the application is running.
RETURN VALUES
NULL The XGetDefault function returns NULL if the resource
referred to by the program and option arguments does not
exist.
FILES
$HOME/.Xdefaults The resource file in the user's home directory that
is used if the specified RESOURCE_MANAGER property
on the root window of screen zero does not exist.
SEE ALSOXrmQGetResource(3X11), XrmSetDatabase(3X11)NOTES
This function is considered obsolete.
X v11 Rel. 6 26 Jul 1999 XGetDefault(3X11)
