MirBSD manpage: XGetTextProperty(3), XSetTextProperty(3)

XSetTextProperty(3X11)   XLIB FUNCTIONS    XSetTextProperty(3X11)


     XSetTextProperty, XGetTextProperty - set and read text pro-


     void XSetTextProperty(Display *display, Window w, XTextPro-
          perty *text_prop, Atom property);

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


     display   Specifies the connection to the X server.

     property  Specifies the property name.

     text_prop Specifies the XTextProperty structure to be used.

               Returns the XTextProperty structure.


     The XSetTextProperty function replaces the existing speci-
     fied property for the named window with the data, type, for-
     mat, and number of items determined by the value field, the
     encoding field, the format field, and the nitems field,
     respectively, of the specified XTextProperty structure. If
     the property does not already exist, XSetTextProperty sets
     it for the specified window.

     XSetTextProperty can generate BadAlloc, BadAtom, BadValue,
     and BadWindow errors.

     The XGetTextProperty function 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 for-
     mat 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 particu-
     lar 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 read and store the data in the XTextPro-
     perty structure, XGetTextProperty returns a nonzero status;
     otherwise, it returns a zero status.

XFree86                   Version 4.5.0                         1

XSetTextProperty(3X11)   XLIB FUNCTIONS    XSetTextProperty(3X11)

     XGetTextProperty can generate BadAtom and BadWindow errors.


               The string name of the machine on which the client
               application is running.

               The command and arguments, null-separated, used to
               invoke the application.

               The name to be used in an icon.

     WM_NAME   The name of the application.


     BadAlloc  The server failed to allocate the requested
               resource or server memory.

     BadAtom   A value for an Atom argument does not name a
               defined Atom.

     BadValue  Some numeric value falls outside the range of
               values accepted by the request. Unless a specific
               range is specified for an argument, the full range
               defined by the argument's type is accepted.  Any
               argument defined as a set of alternatives can gen-
               erate this error.

     BadWindow A value for a Window argument does not name a
               defined Window.


     XAllocClassHint(3X11), XAllocIconSize(3X11),
     XAllocSizeHints(3X11), XAllocWMHints(3X11),
     XSetCommand(3X11), XSetTransientForHint(3X11),
     XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
     XSetWMIconName(3X11), XSetWMName(3X11),
     XSetWMProperties(3X11), XSetWMProtocols(3X11),
     Xlib - C Language X Interface

XFree86                   Version 4.5.0                         2

Generated on 2021-12-07 11:07:08 by $MirOS: src/scripts/roff2htm,v 1.103 2021/01/23 20:24:35 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2021 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.