


XSetTextProperty(3X11)				       XSetTextProperty(3X11)
X11R5									X11R5



NAME
  XSetTextProperty, XGetTextProperty - set and read text properties

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

  Status XGetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p__r_e_t_u_r_n,	_p_r_o_p_e_r_t_y)
	 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;
	 Atom _p_r_o_p_e_r_t_y;

ARGUMENTS

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

  _p_r_o_p_e_r_t_y  Specifies the property name.

  _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.

DESCRIPTION
  The _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y function	replaces the existing specified	property for
  the named window with	the data, type,	format,	and number of items deter-
  mined	by the value field, the	encoding field,	the format field, and the
  nitems field,	respectively, of the specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure.	 If
  the property does not	already	exist, _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y	sets it	for the
  specified window.

  _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate	_B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
  errors.

  The _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y function	reads the specified property from the window
  and stores the data in the returned _X_T_e_x_t_P_r_o_p_e_r_t_y structure.	It stores the
  data in the value field, the type of the data	in the encoding	field, the
  format of the	data in	the format field, and the number of items of data in
  the nitems field.  An	extra byte containing null (which is not included in
  the nitems member) is	stored at the end of the value field of
  text_prop_return.  The particular interpretation of the property's encoding
  and data as ``text'' is left to the calling application.  If the specified
  property does	not exist on the window, _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y sets the value
  field	to NULL, the encoding field to None, the format	field to zero, and
  the nitems field to zero.

  If it	was able to read and store the data in the _X_T_e_x_t_P_r_o_p_e_r_t_y structure,
  _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y returns a nonzero status; otherwise,	it returns a zero
  status.

  _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate	_B_a_d_A_t_o_m	and _B_a_d_W_i_n_d_o_w errors.



PROPERTIES

  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_ICON_NAME
	    The	name to	be used	in an icon.

  WM_NAME   The	name of	the application.

DIAGNOSTICS

  _B_a_d_A_l_l_o_c  The	server failed to allocate the requested	resource or server
	    memory.

  _B_a_d_A_t_o_m   A value for	an Atom	argument does not name a defined Atom.

  _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of values accepted by
	    the	request.  Unless a specific range is specified for an argu-
	    ment, the full range defined by the	argument's type	is accepted.
	    Any	argument defined as a set of alternatives can generate this
	    error.

  _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), XSetCommand(3X11), XSetTransientForHint(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	delim off





























