XDeleteProperty man page on Ultrix

Man page or keyword search:  
man Server   3690 pages
apropos Keyword Search (all sections)
Output format
Ultrix logo
[printable version]

XGetWindowProperty(3X11)	     X11R5	      XGetWindowProperty(3X11)

NAME
       XGetWindowProperty, XListProperties, XChangeProperty, XRotateWindow‐
       Properties, XDeleteProperty - obtain and change window properties

SYNTAX
       int XGetWindowProperty(display, w, property, long_offset, long_length,
       delete, req_type,
			       actual_type_return, actual_format_return,
       nitems_return, bytes_after_return,
			       prop_return)
	     Display *display;
	     Window w;
	     Atom property;
	     long long_offset, long_length;
	     Bool delete;
	     Atom req_type;
	     Atom *actual_type_return;
	     int *actual_format_return;
	     unsigned long *nitems_return;
	     unsigned long *bytes_after_return;
	     unsigned char **prop_return;

       Atom *XListProperties(display, w, num_prop_return)
	     Display *display;
	     Window w;
	     int *num_prop_return;

       XChangeProperty(display, w, property, type, format, mode, data, nele‐
       ments)
	     Display *display;
	     Window w;
	     Atom property, type;
	     int format;
	     int mode;
	     unsigned char *data;
	     int nelements;

       XRotateWindowProperties(display, w, properties, num_prop, npositions)
	     Display *display;
	     Window w;
	     Atom properties[];
	     int num_prop;
	     int npositions;

       XDeleteProperty(display, w, property)
	     Display *display;
	     Window w;
	     Atom property;

ARGUMENTS
       actual_format_return
		 Returns the actual format of the property.

       actual_type_return
		 Returns the atom identifier  that defines the actual type of
		 the property.

       bytes_after_return
		 Returns the number of bytes remaining to be read in the prop‐
		 erty if a partial read was performed.

       data	 Specifies the property data.

       delete	 Specifies a Boolean value that determines whether the prop‐
		 erty is deleted.

       display	 Specifies the connection to the X server.

       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 cor‐
		 rectly perform byte-swap operations as necessary.  If the
		 format is 16-bit or 32-bit, you must explicitly cast your
		 data pointer to an (unsigned char *) in the call to

       long_length
		 Specifies the length in 32-bit multiples of the data to be
		 retrieved.

       long_offset
		 Specifies the offset in the specified property (in 32-bit
		 quantities) where the data is to be retrieved.

       mode	 Specifies the mode of the operation.  You can pass or

       nelements Specifies the number of elements of the specified data for‐
		 mat.

       nitems_return
		 Returns the actual number of 8-bit, 16-bit, or 32-bit items
		 stored in the prop_return data.

       num_prop	 Specifies the length of the properties array.

       num_prop_return
		 Returns the length of the properties array.

       npositions
		 Specifies the rotation amount.

       prop_return
		 Returns the data in the specified format.

       property	 Specifies the property name.

       properties
		 Specifies the array of properties that are to be rotated.

       req_type	 Specifies the atom identifier associated with the property
		 type or

       type	 Specifies the type of the property.  The X server does not
		 interpret the type but simply passes it back to an applica‐
		 tion that later calls

       w	 Specifies the window whose property you want to obtain,
		 change, rotate or delete.

DESCRIPTION
       The function returns the actual type of the property; the actual format
       of the property; the number of 8-bit, 16-bit, or 32-bit items trans‐
       ferred; the number of bytes remaining to be read in the property; and a
       pointer to the data actually returned.  sets the return arguments as
       follows:

       ·    If the specified property does not exist for the specified window,
	    returns to actual_type_return and the value zero to actual_for‐
	    mat_return and bytes_after_return.	The nitems_return argument is
	    empty.  In this case, the delete argument is ignored.

       ·    If the specified property exists but its type does not match the
	    specified type, returns the actual property type to
	    actual_type_return, the actual property format (never zero) to
	    actual_format_return, and the property length in bytes (even if
	    the actual_format_return is 16 or 32) to bytes_after_return.  It
	    also ignores the delete argument.  The nitems_return argument is
	    empty.

       ·    If the specified property exists and either you assign to the
	    req_type argument or the specified type matches the actual prop‐
	    erty type, returns the actual property type to actual_type_return
	    and the actual property format (never zero) to actual_for‐
	    mat_return.	 It also returns a value to bytes_after_return and
	    nitems_return, by defining the following values:

		    N = actual length of the stored property in bytes
			 (even if the format is 16 or 32)
		    I = 4 * long_offset
		    T = N - I
		    L = MINIMUM(T, 4 * long_length)
		    A = N - (I + L)

	    The returned value starts at byte index I in the property (index‐
	    ing from zero), and its length in bytes is L.  If the value for
	    long_offset causes L to be negative, a error results.  The value
	    of bytes_after_return is A, giving the number of trailing unread
	    bytes in the stored property.

       always allocates one extra byte in prop_return (even if the property is
       zero length) and sets it to ASCII null so that simple properties con‐
       sisting of characters do not have to be copied into yet another string
       before use.  If delete is and bytes_after_return is zero, deletes the
       property from the window and generates a event on the window.

       The function returns if it executes successfully.  To free the result‐
       ing data, use

       can generate and errors.

       The function returns a pointer to an array of atom properties that are
       defined for the specified window or returns NULL if no properties were
       found.  To free the memory allocated by this function, use

       can generate a error.

       The function alters the property for the specified window and causes
       the X server to generate a event on that window.	 performs the follow‐
       ing:

       ·    If mode is discards the previous property value and stores the new
	    data.

       ·    If mode is or inserts the specified data before the beginning of
	    the existing data or onto the end of the existing data, respec‐
	    tively.  The type and format must match the existing property
	    value, or a error results.	If the property is undefined, it is
	    treated as defined with the correct type and format with zero-
	    length data.

       The lifetime of a property is not tied to the storing client.  Proper‐
       ties remain until explicitly deleted, until the window is destroyed, or
       until the server resets.	 For a discussion of what happens when the
       connection to the X server is closed, see section 2.6.  The maximum
       size of a property is server dependent and can vary dynamically depend‐
       ing on the amount of memory the server has available.  (If there is
       insufficient space, a error results.)

       can generate and errors.

       The function allows you to rotate properties on a window and causes the
       X server to generate events.  If the property names in the properties
       array are viewed as being numbered starting from zero and if there are
       num_prop property names in the list, then the value associated with
       property name I becomes the value associated with property name (I +
       npositions) mod N for all I from zero to N - 1.	The effect is to
       rotate the states by npositions places around the virtual ring of prop‐
       erty names (right for positive npositions, left for negative nposi‐
       tions).	If npositions mod N is nonzero, the X server generates a event
       for each property in the order that they are listed in the array.  If
       an atom occurs more than once in the list or no property with that name
       is defined for the window, a error results.  If a or error results, no
       properties are changed.

       can generate and errors.

       The function deletes the specified property only if the property was
       defined on the specified window and causes the X server to generate a
       event on the window unless the property does not exist.

       can generate and errors.

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

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

       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 generate this
		 error.

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

SEE ALSO
       XFree(3X11), XInternAtom(3X11)
       Xlib - C Language X Interface

						      XGetWindowProperty(3X11)
[top]

List of man pages available for Ultrix

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net