NAME
XSetWMProperties, XmbSetWMProperties, Xutf8SetWMProperties - set stan‐ dard window properties SYNTAX void XSetWMProperties(Display *display, Window w, XTextProperty *win‐ downame, XTextProperty *iconname, char **argv, int argc, XSizeHints *normalhints, XWMHints *wmhints, XClassHint *classhints); void XmbSetWMProperties(Display *display, Window w, char *windowname, char *iconname, char *argv[], int argc, XSizeHints *nor‐ malhints, XWMHints *wmhints, XClassHint *classhints); void Xutf8SetWMProperties(Display *display, Window w, char *win‐ downame, char *iconname, char *argv[], int argc, XSizeHints *normalhints, XWMHints *wmhints, XClassHint *classhints); ARGUMENTS argc Specifies the number of arguments. argv Specifies the application's argument list. classhints Specifies the XClassHint structure to be used. display Specifies the connection to the X server.
iconname Specifies the icon name, which should be a null-terminated string. normalhints Specifies the size hints for the window in its normal state. w Specifies the window. windowname
Specifies the window name, which should be a null-terminated string. wmhints Specifies the XWMHints structure to be used. DESCRIPTION The XSetWMProperties convenience function provides a single programming interface for setting those essential window properties that are used for communicating with other clients (particularly window and session managers).
If the windowname argument is non-NULL, XSetWMProperties calls XSetWM‐ Name, which in turn, sets the WMNAME property (see section 14.1.4).
If the iconname argument is non-NULL, XSetWMProperties calls XSetWMI‐ conName, which sets the WMICONNAME property (see section 14.1.5). If
the argv argument is non-NULL, XSetWMProperties calls XSetCommand, which sets the WMCOMMAND property (see section 14.2.1). Note that an
argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using XSetWMClientMachine (see section 14.2.2).
If the normalhints argument is non-NULL, XSetWMProperties calls XSetWMNormalHints, which sets the WMNORMALHINTS property (see section
14.1.7). If the wmhints argument is non-NULL, XSetWMProperties calls XSetWMHints, which sets the WMHINTS property (see section 14.1.6).
If the classhints argument is non-NULL, XSetWMProperties calls XSet‐ ClassHint, which sets the WMCLASS property (see section 14.1.8). If the resname member in the XClassHint structure is set to the NULL pointer and the RESOURCENAME environment variable is set, then the value of the environment variable is substituted for resname. If the resname member is NULL, the environment variable is not set, and argv and argv[0] are set, then the value of argv[0], stripped of any direc‐ tory prefixes, is substituted for resname. The XmbSetWMProperties and Xutf8SetWMProperties convenience functions provide a simple programming interface for setting those essential win‐ dow properties that are used for communicating with other clients (par‐ ticularly window and session managers).
If the windowname argument is non-NULL, they set the WMNAME property.
If the iconname argument is non-NULL, they set the WMICONNAME prop‐
erty. The windowname and iconname arguments are null-terminated strings, for XmbSetWMProperties in the encoding of the current locale,
for Xutf8SetWMProperties in UTF-8 encoding. If the arguments can be fully converted to the STRING encoding, the properties are created with type ``STRING''; otherwise, the arguments are converted to Compound Text, and the properties are created with type ``COMPOUNDTEXT''.
If the normalhints argument is non-NULL, XmbSetWMProperties and Xutf8SetWMProperties call XSetWMNormalHints, which sets the WMNOR‐ MALHINTS property (see section 14.1.7). If the wmhints argument is
non-NULL, XmbSetWMProperties and Xutf8SetWMProperties call XSetWMHints, which sets the WMHINTS property (see section 14.1.6).
If the argv argument is non-NULL, XmbSetWMProperties and Xutf8SetWM‐ Properties set the WMCOMMAND property from argv and argc. An argc of
zero indicates a zero-length command. The hostname of the machine is stored using XSetWMClientMachine (see section 14.2.2).
If the classhints argument is non-NULL, XmbSetWMProperties and Xutf8SetWMProperties set the WMCLASS property. If the resname member in the XClassHint structure is set to the NULL pointer and the RESOURCENAME environment variable is set, the value of the environment variable is substituted for resname. If the resname member is NULL, the environment variable is not set, and argv and argv[0] are set, then the value of argv[0], stripped of any directory prefixes, is substi‐ tuted for resname. It is assumed that the supplied classhints.resname and argv, the RESOURCENAME environment variable, and the hostname of the machine are in the encoding of the current locale. The corresponding WMCLASS, WMCOMMAND, and WMCLIENTMACHINE properties are typed according to the local host locale announcer. No encoding conversion is performed for these strings prior to storage in the properties. For clients that need to process the property text in a locale, Xmb‐ SetWMProperties and Xutf8SetWMProperties set the WMLOCALENAME prop‐ erty to be the name of the current locale. The name is assumed to be in the Host Portable Character Encoding and is converted to STRING for storage in the property. XSetWMProperties, XmbSetWMProperties and Xutf8SetWMProperties can gen‐ erate BadAlloc and BadWindow errors. The function Xutf8SetWMProperties is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro XHAVEUTF8STRING. PROPERTIES WMCLASS Set by application programs to allow window and session man‐ agers to obtain the application's resources from the resource database. WMCLIENTMACHINE The string name of the machine on which the client applica‐ tion is running. WMCOMMAND
The command and arguments, null-separated, used to invoke the application. WMHINTS Additional hints set by the client for use by the window man‐ ager. The C type of this property is XWMHints. WMICONNAME The name to be used in an icon. WMNAME The name of the application. WMNORMALHINTS Size hints for a window in its normal state. The C type of this property is XSizeHints. DIAGNOSTICS BadAlloc The server failed to allocate the requested resource or server memory. BadWindow A value for a Window argument does not name a defined Window. SEE ALSO XAllocClassHint(3), XAllocIconSize(3), XAllocSizeHints(3), XAl‐ locWMHints(3), XParseGeometry(3), XSetCommand(3), XSetTransient‐ ForHint(3), XSetTextProperty(3), XSetWMClientMachine(3), XSetWMCol‐ ormapWindows(3), XSetWMIconName(3), XSetWMName(3), XSetWMProtocols(3), XStringListToTextProperty(3), XTextListToTextProperty(3)
Xlib - C Language X Interface X Version 11 libX11 1.6.5 XSetWMProperties(3)