doc/fontconfig-devel/fcconfigfileinfoiterget.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 >FcConfigFileInfoIterGet</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="FcConfigFileInfoIterNext"
  16 HREF="fcconfigfileinfoiternext.html"></HEAD
  17 ><BODY
  18 CLASS="REFENTRY"
  19 BGCOLOR="#FFFFFF"
  20 TEXT="#000000"
  21 LINK="#0000FF"
  22 VLINK="#840084"
  23 ALINK="#0000FF"
  24 ><DIV
  25 CLASS="NAVHEADER"
  26 ><TABLE
  27 SUMMARY="Header navigation table"
  28 WIDTH="100%"
  29 BORDER="0"
  30 CELLPADDING="0"
  31 CELLSPACING="0"
  32 ><TR
  33 ><TH
  34 COLSPAN="3"
  35 ALIGN="center"
  36 ></TH
  37 ></TR
  38 ><TR
  39 ><TD
  40 WIDTH="10%"
  41 ALIGN="left"
  42 VALIGN="bottom"
  43 ><A
  44 HREF="fcconfigfileinfoiternext.html"
  45 ACCESSKEY="P"
  46 >&#60;&#60;&#60; Previous</A
  47 ></TD
  48 ><TD
  49 WIDTH="80%"
  50 ALIGN="center"
  51 VALIGN="bottom"
  52 ></TD
  53 ><TD
  54 WIDTH="10%"
  55 ALIGN="right"
  56 VALIGN="bottom"
  57 >&nbsp;</TD
  58 ></TR
  59 ></TABLE
  60 ><HR
  61 ALIGN="LEFT"
  62 WIDTH="100%"></DIV
  63 ><H1
  64 ><A
  65 NAME="FCCONFIGFILEINFOITERGET"
  66 ></A
  67 >FcConfigFileInfoIterGet</H1
  68 ><DIV
  69 CLASS="REFNAMEDIV"
  70 ><A
  71 NAME="AEN3855"
  72 ></A
  73 ><H2
  74 >Name</H2
  75 >FcConfigFileInfoIterGet&nbsp;--&nbsp;Obtain the configuration file information</DIV
  76 ><DIV
  77 CLASS="REFSYNOPSISDIV"
  78 ><A
  79 NAME="AEN3858"
  80 ></A
  81 ><H2
  82 >Synopsis</H2
  83 ><DIV
  84 CLASS="FUNCSYNOPSIS"
  85 ><P
  86 ></P
  87 ><A
  88 NAME="AEN3859"
  89 ></A
  90 ><TABLE
  91 BORDER="0"
  92 BGCOLOR="#E0E0E0"
  93 WIDTH="100%"
  94 ><TR
  95 ><TD
  96 ><PRE
  97 CLASS="FUNCSYNOPSISINFO"
  98 >#include &#60;fontconfig/fontconfig.h&#62;
  99         </PRE
 100 ></TD
 101 ></TR
 102 ></TABLE
 103 ><P
 104 ><CODE
 105 ><CODE
 106 CLASS="FUNCDEF"
 107 >FcBool <TT
 108 CLASS="FUNCTION"
 109 >FcConfigFileInfoIterGet</TT
 110 ></CODE
 111 >(FcConfig *<TT
 112 CLASS="PARAMETER"
 113 ><I
 114 >config</I
 115 ></TT
 116 >, FcConfigFileInfoIter *<TT
 117 CLASS="PARAMETER"
 118 ><I
 119 >iter</I
 120 ></TT
 121 >, FcChar8 **<TT
 122 CLASS="PARAMETER"
 123 ><I
 124 >name</I
 125 ></TT
 126 >, FcChar8 **<TT
 127 CLASS="PARAMETER"
 128 ><I
 129 >description</I
 130 ></TT
 131 >, FcBool *<TT
 132 CLASS="PARAMETER"
 133 ><I
 134 >enabled</I
 135 ></TT
 136 >);</CODE
 137 ></P
 138 ><P
 139 ></P
 140 ></DIV
 141 ></DIV
 142 ><DIV
 143 CLASS="REFSECT1"
 144 ><A
 145 NAME="AEN3874"
 146 ></A
 147 ><H2
 148 >Description</H2
 149 ><P
 150 >Obtain the filename, the description and the flag whether it is enabled or not
 151 for 'iter' where points to current configuration file information.
 152 If the iterator is invalid, FcFalse is returned.
 153     </P
 154 ><P
 155 >This function isn't MT-safe. <TT
 156 CLASS="FUNCTION"
 157 >FcConfigReference</TT
 158 > must be called
 159 before using <TT
 160 CLASS="FUNCTION"
 161 >FcConfigFileInfoIterInit</TT
 162 > and then
 163 <TT
 164 CLASS="FUNCTION"
 165 >FcConfigDestroy</TT
 166 > when the relevant values are no longer referenced.
 167             </P
 168 ></DIV
 169 ><DIV
 170 CLASS="REFSECT1"
 171 ><A
 172 NAME="AEN3881"
 173 ></A
 174 ><H2
 175 >Since</H2
 176 ><P
 177 >version 2.12.91</P
 178 ></DIV
 179 ><DIV
 180 CLASS="NAVFOOTER"
 181 ><HR
 182 ALIGN="LEFT"
 183 WIDTH="100%"><TABLE
 184 SUMMARY="Footer navigation table"
 185 WIDTH="100%"
 186 BORDER="0"
 187 CELLPADDING="0"
 188 CELLSPACING="0"
 189 ><TR
 190 ><TD
 191 WIDTH="33%"
 192 ALIGN="left"
 193 VALIGN="top"
 194 ><A
 195 HREF="fcconfigfileinfoiternext.html"
 196 ACCESSKEY="P"
 197 >&#60;&#60;&#60; Previous</A
 198 ></TD
 199 ><TD
 200 WIDTH="34%"
 201 ALIGN="center"
 202 VALIGN="top"
 203 ><A
 204 HREF="t1.html"
 205 ACCESSKEY="H"
 206 >Home</A
 207 ></TD
 208 ><TD
 209 WIDTH="33%"
 210 ALIGN="right"
 211 VALIGN="top"
 212 >&nbsp;</TD
 213 ></TR
 214 ><TR
 215 ><TD
 216 WIDTH="33%"
 217 ALIGN="left"
 218 VALIGN="top"
 219 >FcConfigFileInfoIterNext</TD
 220 ><TD
 221 WIDTH="34%"
 222 ALIGN="center"
 223 VALIGN="top"
 224 ><A
 225 HREF="x103.html#AEN3038"
 226 ACCESSKEY="U"
 227 >Up</A
 228 ></TD
 229 ><TD
 230 WIDTH="33%"
 231 ALIGN="right"
 232 VALIGN="top"
 233 >&nbsp;</TD
 234 ></TR
 235 ></TABLE
 236 ></DIV
 237 ></BODY
 238 ></HTML
 239 >