NAME

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

SYNTAX

XClassHint *XAllocClassHint(void); XSetClassHint(Display *_d_i_s_p_l_a_y, Window _w, XClassHint *_c_l_a_s_s___h_i_n_t_s); Status XGetClassHint(Display *_d_i_s_p_l_a_y, Window _w, XClassHint *_c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n);

ARGUMENTS

_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_l_a_s_s___h_i_n_t_s Specifies the
_X_C_l_a_s_s_H_i_n_t structure that is to be used.
_c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n Returns the
_X_C_l_a_s_s_H_i_n_t structure.
_w Specifies the window.

DESCRIPTION

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

The _X_S_e_t_C_l_a_s_s_H_i_n_t 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.

_X_S_e_t_C_l_a_s_s_H_i_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.

The _X_G_e_t_C_l_a_s_s_H_i_n_t 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 _X_F_r_e_e on each individually.

_X_G_e_t_C_l_a_s_s_H_i_n_t can generate a _B_a_d_W_i_n_d_o_w error.

PROPERTIES

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

STRUCTURES

The _X_C_l_a_s_s_H_i_n_t 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

_B_a_d_A_l_l_o_c
The server failed to allocate the requested resource or server memory.
_B_a_d_W_i_n_d_o_w
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), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e