Update documentation for stale FcConfigGetConfig function.
[platform/upstream/fontconfig.git] / doc / fcconstant.fncs
1 /*
2  * $Id$
3  *
4  * Copyright © 2003 Keith Packard
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
10  * documentation, and that the name of Keith Packard not be used in
11  * advertising or publicity pertaining to distribution of the software without
12  * specific, written prior permission.  Keith Packard makes no
13  * representations about the suitability of this software for any purpose.  It
14  * is provided "as is" without express or implied warranty.
15  *
16  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
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
27 @TYPE2@         int%                            @ARG2@          nconsts
28 @PURPOSE@       Register symbolic constants
29 @DESC@
30 Register <parameter>nconsts</parameter> new symbolic constants.
31 @@
32
33 @RET@           FcBool
34 @FUNC@          FcNameUnregisterConstants
35 @TYPE1@         const FcConstant *              @ARG1@          consts
36 @TYPE2@         int%                            @ARG2@          nconsts
37 @PURPOSE@       Unregister symbolic constants
38 @DESC@
39 Unregister <parameter>nconsts</parameter> symbolic constants.
40 @@
41
42 @RET@           const FcConstant *
43 @FUNC@          FcNameGetConstant
44 @TYPE1@         FcChar8 *                       @ARG1@          string
45 @PURPOSE@       Lookup symbolic constant
46 @DESC@
47 Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
48 @@
49
50 @RET@           FcBool
51 @FUNC@          FcNameConstant
52 @TYPE1@         FcChar8 *                       @ARG1@          string
53 @TYPE2@         int *                           @ARG2@          result
54 @PURPOSE@       Get the value for a symbolic constant
55 @DESC@
56 Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
57 placing the value of the constant in <parameter>result</parameter> if present.
58 @@