← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libxi/trusty-security

« back to all changes in this revision

Viewing changes to man/XIChangeProperty.man

  • Committer: Package Import Robot
  • Author(s): Christopher James Halse Rogers
  • Date: 2012-01-18 11:44:39 UTC
  • mfrom: (1.1.8) (4.1.4 experimental)
  • Revision ID: package-import@ubuntu.com-20120118114439-bm7qksg514zh51do
Tags: 2:1.5.99.2-0ubuntu3
Bump build depends on x11proto-input-dev to 2.1.99.5.  Our 2.1.99.4 package
is really 2.0.2, so 2.1.99.5 is the first version with MT support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/XIChangeProperty.man
2
2
.\"     Title: xichangeproperty
3
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
4
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5
 
.\"      Date: 06/07/2011
 
5
.\"      Date: 12/21/2011
6
6
.\"    Manual: [FIXME: manual]
7
7
.\"    Source: [FIXME: source]
8
8
.\"  Language: English
9
9
.\"
10
 
.TH "XICHANGEPROPERTY" "libmansuffix" "06/07/2011" "[FIXME: source]" "[FIXME: manual]"
 
10
.TH "XICHANGEPROPERTY" "libmansuffix" "12/21/2011" "[FIXME: source]" "[FIXME: manual]"
11
11
.\" -----------------------------------------------------------------
12
12
.\" * Define some portability stuff
13
13
.\" -----------------------------------------------------------------
124
124
.sp
125
125
.nf
126
126
mode
127
 
       One of PropModeAppend, PropModePrepend or PropModeReplace\&.
 
127
       One of XIPropModeAppend, XIPropModePrepend or XIPropModeReplace\&.
128
128
.fi
129
129
.sp
130
130
.nf
189
189
.sp -1
190
190
.IP \(bu 2.3
191
191
.\}
192
 
If the specified property exists and either you assign AnyPropertyType to the req_type argument or the specified type matches the actual property type, XIGetProperty returns the actual property type to actual_type_return and the actual property format (never zero) to actual_format_return\&. It also returns a value to bytes_after_return and nitems_return, by defining the following values:
 
192
If the specified property exists and either you assign XIAnyPropertyType to the req_type argument or the specified type matches the actual property type, XIGetProperty returns the actual property type to actual_type_return and the actual property format (never zero) to actual_format_return\&. It also returns a value to bytes_after_return and nitems_return, by defining the following values:
193
193
.sp
194
194
.if n \{\
195
195
.RS 4
228
228
.sp -1
229
229
.IP \(bu 2.3
230
230
.\}
231
 
If mode is PropModeReplace, XIChangeProperty discards the previous property value and stores the new data\&.
 
231
If mode is XIPropModeReplace, XIChangeProperty discards the previous property value and stores the new data\&.
232
232
.RE
233
233
.sp
234
234
.RS 4
239
239
.sp -1
240
240
.IP \(bu 2.3
241
241
.\}
242
 
If mode is PropModePrepend or PropModeAppend, XIChangeProperty inserts the specified data before the beginning of the existing data or onto the end of the existing data, respectively\&. The type and format must match the existing property value, or a BadMatch error results\&. If the property is undefined, it is treated as defined with the correct type and format with zero\-length data\&.
 
242
If mode is XIPropModePrepend or XIPropModeAppend, XIChangeProperty inserts the specified data before the beginning of the existing data or onto the end of the existing data, respectively\&. The type and format must match the existing property value, or a BadMatch error results\&. If the property is undefined, it is treated as defined with the correct type and format with zero\-length data\&.
243
243
.RE
244
244
.sp
245
245
If the specified format is 8, the property data must be a char array\&. If the specified format is 16, the property data must be a uint16_t array\&. If the specified format is 32, the property data must be a uint32_t array\&.
262
262
BadDevice An invalid device was specified\&. The device does not exist\&.
263
263
.sp
264
264
BadAtom An invalid property was specified\&. The property does not exist\&.
 
265
.SH "BUGS"
 
266
.sp
 
267
.if n \{\
 
268
.RS 4
 
269
.\}
 
270
.nf
 
271
The protocol headers for XI 2\&.0 did not provide
 
272
XIAnyPropertyType, XIPropModeReplace, XIPropModePrepend or
 
273
XIPropModeAppend\&. Use AnyPropertyType, PropModeReplace,
 
274
PropModePrepend and PropModeAppend instead, respectively\&.
 
275
.fi
 
276
.if n \{\
 
277
.RE
 
278
.\}
265
279
.SH "SEE ALSO"
266
280
.sp
267
281
XIListProperties(libmansuffix)