


XSetWMIconName(3X11)					 XSetWMIconName(3X11)
X11R5									X11R5



NAME
  XSetWMIconName, XGetWMIconName, XSetIconName,	XGetIconName - set or read a
  window's WM_ICON_NAME	property

SYNTAX
  void XSetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XTextProperty *_t_e_x_t__p_r_o_p;

  Status XGetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p__r_e_t_u_r_n)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XTextProperty *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;

  XSetIconName(_d_i_s_p_l_a_y,	_w, _i_c_o_n__n_a_m_e)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	char *_i_c_o_n__n_a_m_e;

  Status XGetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n__n_a_m_e__r_e_t_u_r_n)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	char **_i_c_o_n__n_a_m_e__r_e_t_u_r_n;

ARGUMENTS

  _d_i_s_p_l_a_y   Specifies the connection to	the X server.

  _i_c_o_n__n_a_m_e Specifies the icon name, which should be a null-terminated
	    string.

  _i_c_o_n__n_a_m_e__r_e_t_u_r_n
	    Returns the	window's icon name, which is a null-terminated
	    string.

  _t_e_x_t__p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y	structure to be	used.

  _t_e_x_t__p_r_o_p__r_e_t_u_r_n
	    Returns the	_X_T_e_x_t_P_r_o_p_e_r_t_y structure.

  _w	    Specifies the window.

DESCRIPTION
  The _X_S_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls	_X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y to set	the
  WM_ICON_NAME property.

  The _X_G_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls	_X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y to obtain
  the WM_ICON_NAME property.  It returns nonzero status	on success; otherwise
  it returns a zero status.


  The _X_S_e_t_I_c_o_n_N_a_m_e function sets the name to be	displayed in a window's	icon.

  _X_S_e_t_I_c_o_n_N_a_m_e 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_I_c_o_n_N_a_m_e function returns the	name to	be displayed in	the specified
  window's icon.  If it	succeeds, it returns nonzero; otherwise, if no icon
  name has been	set for	the window, it returns zero.  If you never assigned a
  name to the window, _X_G_e_t_I_c_o_n_N_a_m_e sets	icon_name_return to NULL.  If the
  data returned	by the server is in the	Latin Portable Character Encoding,
  then the returned string is in the Host Portable Character Encoding.	Oth-
  erwise, the result is	implementation dependent.  When	finished with it, a
  client must free the icon name string	using _X_F_r_e_e.

  _X_G_e_t_I_c_o_n_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w	error.

PROPERTIES

  WM_ICON_NAME
	    The	name to	be used	in an icon.

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
  XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11),
  XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11),
  XSetTransientForHint(3X11), XSetTextProperty(3X11),
  XSetWMClientMachine(3X11), XSetWMColormapWindows(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	delim off





































