]> git.wh0rd.org - fontconfig.git/blame - doc/fcconstant.fncs
Cleanup copyright notices to replace "Keith Packard" with "the author(s)"
[fontconfig.git] / doc / fcconstant.fncs
CommitLineData
bfc2dc3a 1/*
e690fbb2 2 * fontconfig/doc/fcconstant.fncs
bfc2dc3a 3 *
46b51147 4 * Copyright © 2003 Keith Packard
bfc2dc3a
KP
5 *
6 * Permission to use, copy, modify, distribute, and sell this software and its
7 * documentation for any purpose is hereby granted without fee, provided that
8 * the above copyright notice appear in all copies and that both that
9 * copyright notice and this permission notice appear in supporting
5aaf466d 10 * documentation, and that the name of the author(s) not be used in
bfc2dc3a 11 * advertising or publicity pertaining to distribution of the software without
5aaf466d 12 * specific, written prior permission. The authors make no
bfc2dc3a
KP
13 * representations about the suitability of this software for any purpose. It
14 * is provided "as is" without express or implied warranty.
15 *
3074a73b 16 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
bfc2dc3a 17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
3074a73b 18 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
bfc2dc3a
KP
19 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22 * PERFORMANCE OF THIS SOFTWARE.
23 */
24@RET@ FcBool
25@FUNC@ FcNameRegisterConstants
26@TYPE1@ const FcConstant * @ARG1@ consts
61895ed1 27@TYPE2@ int% @ARG2@ nconsts
bfc2dc3a
KP
28@PURPOSE@ Register symbolic constants
29@DESC@
fab44f3c
KP
30Register <parameter>nconsts</parameter> new symbolic constants. Returns
31FcFalse if the constants cannot be registered (due to allocation failure).
32Otherwise returns FcTrue.
bfc2dc3a
KP
33@@
34
35@RET@ FcBool
36@FUNC@ FcNameUnregisterConstants
37@TYPE1@ const FcConstant * @ARG1@ consts
61895ed1 38@TYPE2@ int% @ARG2@ nconsts
bfc2dc3a
KP
39@PURPOSE@ Unregister symbolic constants
40@DESC@
fab44f3c
KP
41Unregister <parameter>nconsts</parameter> symbolic constants. Returns
42FcFalse if the specified constants were not registered. Otherwise returns
43FcTrue.
bfc2dc3a
KP
44@@
45
46@RET@ const FcConstant *
47@FUNC@ FcNameGetConstant
48@TYPE1@ FcChar8 * @ARG1@ string
49@PURPOSE@ Lookup symbolic constant
50@DESC@
2df0c662 51Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
bfc2dc3a
KP
52@@
53
54@RET@ FcBool
55@FUNC@ FcNameConstant
56@TYPE1@ FcChar8 * @ARG1@ string
57@TYPE2@ int * @ARG2@ result
58@PURPOSE@ Get the value for a symbolic constant
59@DESC@
2df0c662
KP
60Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
61placing the value of the constant in <parameter>result</parameter> if present.
bfc2dc3a 62@@