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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
|
.\" 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_prop_values" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_get_prop_values \- Get multiple values of a text property.
.SH SYNOPSIS
int
\fBmtext_get_prop_values\fP (\fBMText\fP *
\fImt\fP, int
\fIpos\fP, \fBMSymbol\fP
\fIkey\fP, void **
\fIvalues\fP, int
\fInum\fP)
.SH DESCRIPTION
Get multiple values of a text property. The
.ft B
mtext_get_prop_values()
.ft R
function searches the character at
.ft B
pos
.ft R
in M\-text
.ft B
mt
.ft R
for the property whose key is
.ft B
key\fP.
.ft R
If such a property is found, its values are stored in the memory area pointed to by
.ft B
values\fP.
.ft R
.ft B
num
.ft R
limits the maximum number of stored values.
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful,
.ft B
mtext_get_prop_values()
.ft R
returns the number of actually stored values. If the character at
.ft B
pos
.ft R
does not have a property whose key is
.ft B
key\fP,
.ft R
the return value is 0. If an error is detected,
.ft B
mtext_get_prop_values()
.ft R
returns \-1 and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_RANGE\fP,
.ft R
.ft C
MERROR_SYMBOL
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmtext_get_prop()\fP,
.ft R
.ft B
mtext_put_prop()\fP,
.ft R
.ft B
mtext_put_prop_values()\fP,
.ft R
.ft B
mtext_push_prop()\fP,
.ft R
.ft B
mtext_pop_prop()\fP,
.ft R
.ft B
mtext_prop_range()
.ft R
.RE
.PP
.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>.
|