Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   10987 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

XGetTextProperty()					    XGetTextProperty()

Name
  XGetTextProperty – read one of a window's text properties.

Synopsis
  Status XGetTextProperty(display, w, text_prop_return, property)
	Display *display;
	Window w;
	XTextProperty *text_prop_return;
	Atom property;

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

  w	    Specifies the window.

  text_prop_return
	    Returns the XTextProperty structure.

  property  Specifies the property name.

Returns
  Zero on failure, non-zero on success.

Availability
  Release 4 and later.

Description
  XGetTextProperty() reads the specified property  from	 the  window  and
  stores the data in the returned XTextProperty 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 number) 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, XGetTextProperty()
  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 set these files in the XTextProperty structure, XGet‐
  TextProperty()  returns a non-zero status; otherwise, it returns a zero
  status.

  For more information, see Volume One, Chapter 12, Interclient	 Communi‐
  cation.

Structures
     typedef struct {
	 unsigned char *value;	      /* same as Property routines */
	 Atom encoding;		      /* prop type */
	 int format;		      /* prop data format: 8, 16, or 32 */
	 unsigned long nitems;	      /* number of data items in value */
     } XTextProperty;

Errors
  BadAtom
  BadWindow

See Also
  XFreeStringList(),   XSetTextProperty(),   XStringListToTextProperty(),
  XTextPropertytoStringList.

Xlib - Window Manager Hints				    XGetTextProperty()

Vote for polarhome