xgetclasshint(3) [hpux man page]

XGetClassHint() 														   XGetClassHint()

Name
  XGetClassHint - get the XA_WM_CLASS property of a window.

Synopsis
  Status XGetClassHint(display, w, class_hints_return)
	Display *display;
	Window w;
	XClassHint *class_hints_return;

Arguments
  display   Specifies a connection to an X server; returned from XOpenDisplay().

  w	    Specifies the ID of the window for which the property is desired.

  class_hints_return
	    Returns the XClassHint structure.

Returns
  Zero on failure, non-zero on success.

Description
  XGetClassHint() obtains the XA_WM_CLASS property for the specified window.  This property stores the resource class and instance name, that
  the window manager uses to get any resource settings that may control how the window manager manages the application that  set  this	prop-
  erty.   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.  XGetClassHint() returns a Status of zero on failure,  non-zero  on
  success.

  The  XClassHint  structure  returned contains res_class, which is the name of the client such as "emacs", and res_name, which should be the
  first of the following that applies:

  o  Command-line option (-rn name)

  o  A specific environment variable (e.g., RESOURCE_NAME)

  o  The trailing component of argv[0] (after the last /)

  To free res_name and res_class when finished with the strings, use XFree().

  For more information on using hints, see Volume One, Chapter 12, Interclient Communication.

Structures
     typedef struct {
	 char *res_name;
	 char *res_class;
     } XClassHint;

Errors
  BadWindow

See Also
  XAllocClassHint(),   XFetchName(),   XGetIconName(),	 XGetIconSizes(),   XGetNormalHints(),	  XGetSizeHints(),    XGetTransientForHint(),
  XGetWMHints(),  XGetZoomHints(), XSetClassHint(), XSetCommand(), XSetIconName(), XSetIconSizes(), XSetNormalHints(), XSetSizeHints(), XSet-
  TransientForHint(), XSetWMHints(), XSetZoomHints(), XStoreName(), XSetWMProperties(), XSetWMProperties().

Xlib - Window Manager Hints													   XGetClassHint()

XAllocClassHint(3X11)													     XAllocClassHint(3X11)

NAME

       XAllocClassHint, XSetClassHint, XGetClassHint, XClassHint - allocate class hints structure and set or read a window's WM_CLASS property

SYNOPSIS

       XClassHint *XAllocClassHint()

       XSetClassHint(display, w, class_hints)
	       Display *display;
	       Window w;
	       XClassHint *class_hints;

       Status XGetClassHint(display, w, class_hints_return)
	       Display *display;
	       Window w;
	       XClassHint *class_hints_return;

ARGUMENTS

       Specifies the connection to the X server.  Specifies the XClassHint structure that is to be used.  Returns the XClassHint structure.  Spec-
       ifies the window.

DESCRIPTION

       The XAllocClassHint function allocates and returns a pointer to a XClassHint structure. Note that the  pointer  fields  in  the	XClassHint
       structure  are  initially  set  to NULL. If insufficient memory is available, XAllocClassHint returns NULL. To free the memory allocated to
       this structure, use XFree.

       The XSetClassHint function sets the class hint for the specified window. If the strings are not in the Host  Portable  Character  Encoding,
       the result is implementation dependent.

       XSetClassHint can generate BadAlloc and BadWindow errors.

       The XGetClassHint function returns the class hint of the specified window to the members of the supplied structure. 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. It returns a nonzero status on success; otherwise, it returns a zero status. To free res_name and
       res_class when finished with the strings, use XFree on each individually.

       XGetClassHint can generate a BadWindow error.

PROPERTIES

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

STRUCTURES

       The XClassHint structure contains:

       typedef struct {
	       char *res_name;
	       char *res_class; } XClassHint;

       The res_name member contains the application name, and the res_class member contains the application class. Note that the name set in  this
       property  may differ from the name set as WM_NAME. That is, WM_NAME specifies what should be displayed in the title bar and, therefore, can
       contain temporal information (for example, the name of a file currently in an editor's buffer). On the other hand, the  name  specified	as
       part  of  WM_CLASS  is the formal name of the application that should be used when retrieving the application's resources from the resource
       database.

DIAGNOSTICS

       The server failed to allocate the requested resource or server memory.  A value for a Window argument does not name a defined Window.

SEE ALSO

       XAllocIconSize(3X11), XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProp-
       erty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWM-
       Protocols(3X11), XStringListToTextProperty(3X11)

       Xlib -- C Language X Interface

															     XAllocClassHint(3X11)