File: mtext_get_property.3m17n

package info (click to toggle)
m17n-docs 1.6.2-2
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 22,492 kB
  • ctags: 1,495
  • sloc: sh: 1,032; makefile: 406; ansic: 206; perl: 108
file content (80 lines) | stat: -rw-r--r-- 1,963 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mtext_get_property" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_get_property \- Get the topmost text property. 


.SH SYNOPSIS
\fBMTextProperty\fP*
\fBmtext_get_property\fP (\fBMText\fP *
\fImt\fP, int
\fIpos\fP, \fBMSymbol\fP
\fIkey\fP)


.SH DESCRIPTION
Get the topmost text property. The
.ft B
mtext_get_property()
.ft R
function searches the character at position
.ft B
pos
.ft R
in M\-text
.ft B
mt
.ft R
for a text property whose key is
.ft B
key\fP.
.ft R
.PP
.SH RETURN VALUE
.PP
.RS 4
If a text property is found,
.ft B
mtext_get_property()
.ft R
returns it. If there are multiple text properties, it returns the topmost one. If no such property is found, it returns
.ft C
NULL
.ft R
without changing the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
If an error is detected,
.ft B
mtext_get_property()
.ft R
returns
.ft C
NULL
.ft R
and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.