xcbchangeproperty(3) XCB Requests xcbchangeproperty(3)

NAME
       xcbchangeproperty - Changes a window property

SYNOPSIS
       #include 

   Request function
       xcbvoidcookiet xcbchangeproperty(xcbconnectiont *conn,
              uint8t mode, xcbwindowt window, xcbatomt property,
              xcbatomt type, uint8t format, uint32t datalen, const
              void *data);

REQUEST ARGUMENTS
       conn      The XCB connection to X11.

       mode      One of the following values:

                 XCBPROPMODEREPLACE
                           Discard the previous property value and store the
                           new data.

                 XCBPROPMODEPREPEND
                           Insert the new data before the beginning of exist‐
                           ing data. The format must match existing property
                           value. If the property is undefined, it is treated
                           as defined with the correct type and format with
                           zero-length data.

                 XCBPROPMODEAPPEND
                           Insert the new data after the beginning of existing
                           data. The format must match existing property val‐
                           ue. If the property is undefined, it is treated as
                           defined with the correct type and format with zero-
                           length data.



       window    The window whose property you want to change.

       property  The property you want to change (an atom).

       type      The type of the property you want to change (an atom).

       format    Specifies whether the data should be viewed as a list of
                 8-bit, 16-bit or 32-bit quantities. Possible values are 8, 16
                 and 32. This information allows the X server to correctly
                 perform byte-swap operations as necessary.

       datalen  Specifies the number of elements (see format).

       data      The property data.

DESCRIPTION
       Sets or updates a property on the specified window. Properties are for
       example the window title (WMNAME) or its minimum size (WMNOR‐
       MALHINTS).  Protocols such as EWMH also use properties - for example
       EWMH defines the window title, encoded as UTF-8 string, in the
       NETWMNAME property.

RETURN VALUE
       Returns an xcbvoidcookiet. Errors (if any) have to be handled in the
       event loop.

       If you want to handle errors directly with xcbrequestcheck instead,
       use xcbchangepropertychecked. See xcb-requests(3) for details.

ERRORS
       xcballocerrort
                 The X server could not store the property (no memory?).

       xcbatomerrort
                 property or type do not refer to a valid atom.

       xcbmatcherrort
                 TODO: reasons?

       xcbvalueerrort
                 TODO: reasons?

       xcbwindowerrort
                 The specified window does not exist.

EXAMPLE
       /*
        * Sets the WMNAME property of the window to "XCB Example".
        *
        */
       void myexample(xcbconnectiont *conn, xcbwindowt window) {
           xcbchangeproperty(conn,
               XCBPROPMODEREPLACE,
               window,
               XCBATOMWMNAME,
               XCBATOMSTRING,
               8,
               strlen("XCB Example"),
               "XCB Example");
           xcbflush(conn);
       }

SEE ALSO
       xcb-requests(3), xcb-examples(3), xcbinternatom(3), xprop(1)

AUTHOR
       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
       rections and improvements.



X Version 11                      libxcb 1.13           xcbchangeproperty(3)