XSetWMProperties, XmbSetWMProperties, Xutf8SetWMProperties
       - set standard window properties


SYNTAX

       void XSetWMProperties(display, w, window_name, icon_name,
       argv, argc, normal_hints, wm_hints, class_hints)
             Display *display;
             Window w;
             XTextProperty *window_name;
             XTextProperty *icon_name;
             char **argv;
             int argc;
             XSizeHints *normal_hints;
             XWMHints *wm_hints;
             XClassHint *class_hints;

       void XmbSetWMProperties(display, w, window_name,
       icon_name, argv, argc,
                             normal_hints, wm_hints, class_hints)
             Display *display;
             Window w;
             char *window_name;
             char *icon_name;
             char *argv[];
             int argc;
             XSizeHints *normal_hints;
             XWMHints *wm_hints;
             XClassHint *class_hints;

       void Xutf8SetWMProperties(display, w, window_name,
       icon_name, argv, argc,
                             normal_hints, wm_hints, class_hints)
             Display *display;
             Window w;
             char *window_name;
             char *icon_name;
             char *argv[];
             int argc;
             XSizeHints *normal_hints;
             XWMHints *wm_hints;
             XClassHint *class_hints;


ARGUMENTS

       argc      Specifies the number of arguments.

       argv      Specifies the application's argument list.

       class_hints
                 Specifies the XClassHint structure to be used.

       display   Specifies the connection to the X server.



DESCRIPTION

       The XSetWMProperties convenience function provides a sin-
       gle programming interface for setting those essential win-
       dow properties that are used for communicating with other
       clients (particularly window and session managers).

       If the window_name argument is non-NULL, XSetWMProperties
       calls XSetWMName, which in turn, sets the WM_NAME property
       (see section 14.1.4).  If the icon_name argument is non-
       NULL, XSetWMProperties calls XSetWMIconName, which sets
       the WM_ICON_NAME property (see section 14.1.5).  If the
       argv argument is non-NULL, XSetWMProperties calls
       XSetCommand, which sets the WM_COMMAND property (see sec-
       tion 14.2.1).  Note that an argc of zero is allowed to
       indicate a zero-length command.  Note also that the host-
       name of this machine is stored using XSetWMClientMachine
       (see section 14.2.2).

       If the normal_hints argument is non-NULL, XSetWMProperties
       calls XSetWMNormalHints, which sets the WM_NORMAL_HINTS
       property (see section 14.1.7).  If the wm_hints argument
       is non-NULL, XSetWMProperties calls XSetWMHints, which
       sets the WM_HINTS property (see section 14.1.6).

       If the class_hints argument is non-NULL, XSetWMProperties
       calls XSetClassHint, which sets the WM_CLASS property (see
       section 14.1.8).  If the res_name member in the XClassHint
       structure is set to the NULL pointer and the RESOURCE_NAME
       environment variable is set, then the value of the envi-
       ronment variable is substituted for res_name.  If the
       res_name 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 res_name.

       The XmbSetWMProperties and Xutf8SetWMProperties conve-
       nience functions provide a simple programming interface
       for setting those essential window properties that are
       used for communicating with other clients (particularly
       window and session managers).

       If the window_name argument is non-NULL, they set the
       WM_NAME property.  If the icon_name argument is non-NULL,
       they set the WM_ICON_NAME property.  The window_name and
       icon_name arguments are null-terminated strings, for Xmb-
       SetWMProperties 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 proper-
       ties are created with type ``STRING''; otherwise, the
       arguments are converted to Compound Text, and the proper-
       ties are created with type ``COMPOUND_TEXT''.
       Machine (see section 14.2.2).

       If the class_hints argument is non-NULL, XmbSetWMProper-
       ties and Xutf8SetWMProperties set the WM_CLASS property.
       If the res_name member in the XClassHint structure is set
       to the NULL pointer and the RESOURCE_NAME environment
       variable is set, the value of the environment variable is
       substituted for res_name.  If the res_name 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 res_name.

       It is assumed that the supplied class_hints.res_name and
       argv, the RESOURCE_NAME environment variable, and the
       hostname of the machine are in the encoding of the current
       locale.  The corresponding WM_CLASS, WM_COMMAND, and
       WM_CLIENT_MACHINE properties are typed according to the
       local host locale announcer.  No encoding conversion is
       performed for these strings prior to storage in the prop-
       erties.

       For clients that need to process the property text in a
       locale, XmbSetWMProperties and Xutf8SetWMProperties set
       the WM_LOCALE_NAME property 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 Xutf8SetWMProper-
       ties can generate BadAlloc and BadWindow errors.

       The function Xutf8SetWMProperties is an XFree86 extension
       introduced in XFree86 4.0.2. Its presence is indicated by
       the macro X_HAVE_UTF8_STRING.


PROPERTIES

       WM_CLASS  Set by application programs to allow window and
                 session managers to obtain the application's
                 resources from the resource database.

       WM_CLIENT_MACHINE
                 The string name of the machine on which the
                 client application is running.

       WM_COMMAND
                 The command and arguments, null-separated, used
                 to invoke the application.

       WM_HINTS  Additional hints set by the client for use by
                 the window manager.  The C type of this property
                 is XWMHints.

                 defined Window.


SEE ALSO

       XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
       Hints(3X11), XAllocWMHints(3X11), XParseGeometry(3X11),
       XSetCommand(3X11), XSetTransientForHint(3X11), XSet-
       TextProperty(3X11), XSetWMClientMachine(3X11), XSetWMCol-
       ormapWindows(3X11), XSetWMIconName(3X11), XSetWM-
       Name(3X11), XSetWMProtocols(3X11), XStringListToTextProp-
       erty(3X11), XTextListToTextProperty(3X11)
       Xlib - C Language X Interface



X Version 11               Release 6.4                          1