71c09d80814f5a27f54d3cac2d01caf5c2145070
[platform/upstream/fontconfig.git] / doc / fontconfig-devel / fcconfigfilename.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >FcConfigFilename</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 HREF="t1.html"><LINK
11 REL="UP"
12 TITLE="FcConfig"
13 HREF="x102.html#AEN2718"><LINK
14 REL="PREVIOUS"
15 TITLE="FcFontList"
16 HREF="fcfontlist.html"><LINK
17 REL="NEXT"
18 TITLE="FcConfigParseAndLoad"
19 HREF="fcconfigparseandload.html"></HEAD
20 ><BODY
21 CLASS="REFENTRY"
22 BGCOLOR="#FFFFFF"
23 TEXT="#000000"
24 LINK="#0000FF"
25 VLINK="#840084"
26 ALINK="#0000FF"
27 ><DIV
28 CLASS="NAVHEADER"
29 ><TABLE
30 SUMMARY="Header navigation table"
31 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 ></TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="fcfontlist.html"
48 ACCESSKEY="P"
49 >&#60;&#60;&#60; Previous</A
50 ></TD
51 ><TD
52 WIDTH="80%"
53 ALIGN="center"
54 VALIGN="bottom"
55 ></TD
56 ><TD
57 WIDTH="10%"
58 ALIGN="right"
59 VALIGN="bottom"
60 ><A
61 HREF="fcconfigparseandload.html"
62 ACCESSKEY="N"
63 >Next &#62;&#62;&#62;</A
64 ></TD
65 ></TR
66 ></TABLE
67 ><HR
68 ALIGN="LEFT"
69 WIDTH="100%"></DIV
70 ><H1
71 ><A
72 NAME="FCCONFIGFILENAME"
73 ></A
74 >FcConfigFilename</H1
75 ><DIV
76 CLASS="REFNAMEDIV"
77 ><A
78 NAME="AEN3334"
79 ></A
80 ><H2
81 >Name</H2
82 >FcConfigFilename&nbsp;--&nbsp;Find a config file</DIV
83 ><DIV
84 CLASS="REFSYNOPSISDIV"
85 ><A
86 NAME="AEN3337"
87 ></A
88 ><H2
89 >Synopsis</H2
90 ><DIV
91 CLASS="FUNCSYNOPSIS"
92 ><P
93 ></P
94 ><A
95 NAME="AEN3338"
96 ></A
97 ><TABLE
98 BORDER="0"
99 BGCOLOR="#E0E0E0"
100 WIDTH="100%"
101 ><TR
102 ><TD
103 ><PRE
104 CLASS="FUNCSYNOPSISINFO"
105 >#include &#60;fontconfig/fontconfig.h&#62;
106         </PRE
107 ></TD
108 ></TR
109 ></TABLE
110 ><P
111 ><CODE
112 ><CODE
113 CLASS="FUNCDEF"
114 >FcChar8 * <TT
115 CLASS="FUNCTION"
116 >FcConfigFilename</TT
117 ></CODE
118 >(const FcChar8 *<TT
119 CLASS="PARAMETER"
120 ><I
121 >name</I
122 ></TT
123 >);</CODE
124 ></P
125 ><P
126 ></P
127 ></DIV
128 ></DIV
129 ><DIV
130 CLASS="REFSECT1"
131 ><A
132 NAME="AEN3345"
133 ></A
134 ><H2
135 >Description</H2
136 ><P
137 >Given the specified external entity name, return the associated filename.
138 This provides applications a way to convert various configuration file
139 references into filename form.
140     </P
141 ><P
142 >A null or empty <TT
143 CLASS="PARAMETER"
144 ><I
145 >name</I
146 ></TT
147 > indicates that the default configuration file should
148 be used; which file this references can be overridden with the
149 FONTCONFIG_FILE environment variable.  Next, if the name starts with <TT
150 CLASS="PARAMETER"
151 ><I
152 >~</I
153 ></TT
154 >, it
155 refers to a file in the current users home directory.  Otherwise if the name
156 doesn't start with '/', it refers to a file in the default configuration
157 directory; the built-in default directory can be overridden with the
158 FONTCONFIG_PATH environment variable.
159             </P
160 ></DIV
161 ><DIV
162 CLASS="NAVFOOTER"
163 ><HR
164 ALIGN="LEFT"
165 WIDTH="100%"><TABLE
166 SUMMARY="Footer navigation table"
167 WIDTH="100%"
168 BORDER="0"
169 CELLPADDING="0"
170 CELLSPACING="0"
171 ><TR
172 ><TD
173 WIDTH="33%"
174 ALIGN="left"
175 VALIGN="top"
176 ><A
177 HREF="fcfontlist.html"
178 ACCESSKEY="P"
179 >&#60;&#60;&#60; Previous</A
180 ></TD
181 ><TD
182 WIDTH="34%"
183 ALIGN="center"
184 VALIGN="top"
185 ><A
186 HREF="t1.html"
187 ACCESSKEY="H"
188 >Home</A
189 ></TD
190 ><TD
191 WIDTH="33%"
192 ALIGN="right"
193 VALIGN="top"
194 ><A
195 HREF="fcconfigparseandload.html"
196 ACCESSKEY="N"
197 >Next &#62;&#62;&#62;</A
198 ></TD
199 ></TR
200 ><TR
201 ><TD
202 WIDTH="33%"
203 ALIGN="left"
204 VALIGN="top"
205 >FcFontList</TD
206 ><TD
207 WIDTH="34%"
208 ALIGN="center"
209 VALIGN="top"
210 ><A
211 HREF="x102.html#AEN2718"
212 ACCESSKEY="U"
213 >Up</A
214 ></TD
215 ><TD
216 WIDTH="33%"
217 ALIGN="right"
218 VALIGN="top"
219 >FcConfigParseAndLoad</TD
220 ></TR
221 ></TABLE
222 ></DIV
223 ></BODY
224 ></HTML
225 >