Imported Upstream version 2.14.2
[platform/upstream/fontconfig.git] / doc / fontconfig-devel / fcconfiggetfilename.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 >FcConfigGetFilename</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="x103.html#AEN3038"><LINK
14 REL="PREVIOUS"
15 TITLE="FcConfigFilename"
16 HREF="fcconfigfilename.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="fcconfigfilename.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="FCCONFIGGETFILENAME"
73 ></A
74 >FcConfigGetFilename</H1
75 ><DIV
76 CLASS="REFNAMEDIV"
77 ><A
78 NAME="AEN3676"
79 ></A
80 ><H2
81 >Name</H2
82 >FcConfigGetFilename&nbsp;--&nbsp;Find a config file</DIV
83 ><DIV
84 CLASS="REFSYNOPSISDIV"
85 ><A
86 NAME="AEN3679"
87 ></A
88 ><H2
89 >Synopsis</H2
90 ><DIV
91 CLASS="FUNCSYNOPSIS"
92 ><P
93 ></P
94 ><A
95 NAME="AEN3680"
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 >FcConfigGetFilename</TT
117 ></CODE
118 >(FcConfig *<TT
119 CLASS="PARAMETER"
120 ><I
121 >config</I
122 ></TT
123 >, const FcChar8 *<TT
124 CLASS="PARAMETER"
125 ><I
126 >name</I
127 ></TT
128 >);</CODE
129 ></P
130 ><P
131 ></P
132 ></DIV
133 ></DIV
134 ><DIV
135 CLASS="REFSECT1"
136 ><A
137 NAME="AEN3689"
138 ></A
139 ><H2
140 >Description</H2
141 ><P
142 >Given the specified external entity name, return the associated filename.
143 This provides applications a way to convert various configuration file
144 references into filename form.
145     </P
146 ><P
147 >A null or empty <TT
148 CLASS="PARAMETER"
149 ><I
150 >name</I
151 ></TT
152 > indicates that the default configuration file should
153 be used; which file this references can be overridden with the
154 FONTCONFIG_FILE environment variable.  Next, if the name starts with <TT
155 CLASS="PARAMETER"
156 ><I
157 >~</I
158 ></TT
159 >, it
160 refers to a file in the current users home directory.  Otherwise if the name
161 doesn't start with '/', it refers to a file in the default configuration
162 directory; the built-in default directory can be overridden with the
163 FONTCONFIG_PATH environment variable.
164     </P
165 ><P
166 >The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality.
167             </P
168 ></DIV
169 ><DIV
170 CLASS="NAVFOOTER"
171 ><HR
172 ALIGN="LEFT"
173 WIDTH="100%"><TABLE
174 SUMMARY="Footer navigation table"
175 WIDTH="100%"
176 BORDER="0"
177 CELLPADDING="0"
178 CELLSPACING="0"
179 ><TR
180 ><TD
181 WIDTH="33%"
182 ALIGN="left"
183 VALIGN="top"
184 ><A
185 HREF="fcconfigfilename.html"
186 ACCESSKEY="P"
187 >&#60;&#60;&#60; Previous</A
188 ></TD
189 ><TD
190 WIDTH="34%"
191 ALIGN="center"
192 VALIGN="top"
193 ><A
194 HREF="t1.html"
195 ACCESSKEY="H"
196 >Home</A
197 ></TD
198 ><TD
199 WIDTH="33%"
200 ALIGN="right"
201 VALIGN="top"
202 ><A
203 HREF="fcconfigparseandload.html"
204 ACCESSKEY="N"
205 >Next &#62;&#62;&#62;</A
206 ></TD
207 ></TR
208 ><TR
209 ><TD
210 WIDTH="33%"
211 ALIGN="left"
212 VALIGN="top"
213 >FcConfigFilename</TD
214 ><TD
215 WIDTH="34%"
216 ALIGN="center"
217 VALIGN="top"
218 ><A
219 HREF="x103.html#AEN3038"
220 ACCESSKEY="U"
221 >Up</A
222 ></TD
223 ><TD
224 WIDTH="33%"
225 ALIGN="right"
226 VALIGN="top"
227 >FcConfigParseAndLoad</TD
228 ></TR
229 ></TABLE
230 ></DIV
231 ></BODY
232 ></HTML
233 >