doc/xml/gnome-vfs-application-registry.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-application-registry">
   2 <refmeta>
   3 <refentrytitle>Application Registry</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>Application Registry</refname><refpurpose>
  10 stores supported MIME types and URIs of various applications</refpurpose>
  11 </refnamediv>
  12
  13 <refsynopsisdiv><title>Synopsis</title>
  14
  15 <synopsis>
  16
  17
  18
  19 #define     <link linkend="GNOME-VFS-APPLICATION-REGISTRY-COMMAND-CAPS">GNOME_VFS_APPLICATION_REGISTRY_COMMAND</link>
  20 #define     <link linkend="GNOME-VFS-APPLICATION-REGISTRY-NAME-CAPS">GNOME_VFS_APPLICATION_REGISTRY_NAME</link>
  21 #define     <link linkend="GNOME-VFS-APPLICATION-REGISTRY-CAN-OPEN-MULTIPLE-FILES-CAPS">GNOME_VFS_APPLICATION_REGISTRY_CAN_OPEN_MULTIPLE_FILES</link>
  22 #define     <link linkend="GNOME-VFS-APPLICATION-REGISTRY-REQUIRES-TERMINAL-CAPS">GNOME_VFS_APPLICATION_REGISTRY_REQUIRES_TERMINAL</link>
  23 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-application-registry-exists">gnome_vfs_application_registry_exists</link>
  24                                             (const <link linkend="char">char</link> *app_id);
  25 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-application-registry-get-keys">gnome_vfs_application_registry_get_keys</link>
  26                                             (const <link linkend="char">char</link> *app_id);
  27 const <link linkend="char">char</link>* <link linkend="gnome-vfs-application-registry-peek-value">gnome_vfs_application_registry_peek_value</link>
  28                                             (const <link linkend="char">char</link> *app_id,
  29                                              const <link linkend="char">char</link> *key);
  30 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-application-registry-get-bool-value">gnome_vfs_application_registry_get_bool_value</link>
  31                                             (const <link linkend="char">char</link> *app_id,
  32                                              const <link linkend="char">char</link> *key,
  33                                              <link linkend="gboolean">gboolean</link> *got_key);
  34 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-remove-application">gnome_vfs_application_registry_remove_application</link>
  35                                             (const <link linkend="char">char</link> *app_id);
  36 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-set-value">gnome_vfs_application_registry_set_value</link>
  37                                             (const <link linkend="char">char</link> *app_id,
  38                                              const <link linkend="char">char</link> *key,
  39                                              const <link linkend="char">char</link> *value);
  40 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-set-bool-value">gnome_vfs_application_registry_set_bool_value</link>
  41                                             (const <link linkend="char">char</link> *app_id,
  42                                              const <link linkend="char">char</link> *key,
  43                                              <link linkend="gboolean">gboolean</link> value);
  44 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-unset-key">gnome_vfs_application_registry_unset_key</link>
  45                                             (const <link linkend="char">char</link> *app_id,
  46                                              const <link linkend="char">char</link> *key);
  47 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-application-registry-get-applications">gnome_vfs_application_registry_get_applications</link>
  48                                             (const <link linkend="char">char</link> *mime_type);
  49 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-application-registry-get-mime-types">gnome_vfs_application_registry_get_mime_types</link>
  50                                             (const <link linkend="char">char</link> *app_id);
  51 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-application-registry-supports-mime-type">gnome_vfs_application_registry_supports_mime_type</link>
  52                                             (const <link linkend="char">char</link> *app_id,
  53                                              const <link linkend="char">char</link> *mime_type);
  54 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-application-registry-supports-uri-scheme">gnome_vfs_application_registry_supports_uri_scheme</link>
  55                                             (const <link linkend="char">char</link> *app_id,
  56                                              const <link linkend="char">char</link> *uri_scheme);
  57 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-application-is-user-owned-application">gnome_vfs_application_is_user_owned_application</link>
  58                                             (const <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);
  59 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-clear-mime-types">gnome_vfs_application_registry_clear_mime_types</link>
  60                                             (const <link linkend="char">char</link> *app_id);
  61 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-add-mime-type">gnome_vfs_application_registry_add_mime_type</link>
  62                                             (const <link linkend="char">char</link> *app_id,
  63                                              const <link linkend="char">char</link> *mime_type);
  64 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-remove-mime-type">gnome_vfs_application_registry_remove_mime_type</link>
  65                                             (const <link linkend="char">char</link> *app_id,
  66                                              const <link linkend="char">char</link> *mime_type);
  67 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-application-registry-sync">gnome_vfs_application_registry_sync</link>
  68                                             (void);
  69 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-shutdown">gnome_vfs_application_registry_shutdown</link>
  70                                             (void);
  71 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-reload">gnome_vfs_application_registry_reload</link>
  72                                             (void);
  73 <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* <link linkend="gnome-vfs-application-registry-get-mime-application">gnome_vfs_application_registry_get_mime_application</link>
  74                                             (const <link linkend="char">char</link> *app_id);
  75 <link linkend="void">void</link>        <link linkend="gnome-vfs-application-registry-save-mime-application">gnome_vfs_application_registry_save_mime_application</link>
  76                                             (const <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);
  77 </synopsis>
  78 </refsynopsisdiv>
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88 <refsect1>
  89 <title>Description</title>
  90 <para>
  91
  92 </para>
  93 </refsect1>
  94
  95 <refsect1>
  96 <title>Details</title>
  97 <refsect2>
  98 <title><anchor id="GNOME-VFS-APPLICATION-REGISTRY-COMMAND-CAPS"/>GNOME_VFS_APPLICATION_REGISTRY_COMMAND</title>
  99 <indexterm><primary>GNOME_VFS_APPLICATION_REGISTRY_COMMAND</primary></indexterm><programlisting>#define GNOME_VFS_APPLICATION_REGISTRY_COMMAND "command"
 100 </programlisting>
 101 <para>
 102 Application registry key for fetching the command to execute
 103 an application.</para>
 104 <para>
 105
 106 </para></refsect2>
 107 <refsect2>
 108 <title><anchor id="GNOME-VFS-APPLICATION-REGISTRY-NAME-CAPS"/>GNOME_VFS_APPLICATION_REGISTRY_NAME</title>
 109 <indexterm><primary>GNOME_VFS_APPLICATION_REGISTRY_NAME</primary></indexterm><programlisting>#define GNOME_VFS_APPLICATION_REGISTRY_NAME "name"
 110 </programlisting>
 111 <para>
 112 Application registry key for fetching the name of an application.</para>
 113 <para>
 114
 115 </para></refsect2>
 116 <refsect2>
 117 <title><anchor id="GNOME-VFS-APPLICATION-REGISTRY-CAN-OPEN-MULTIPLE-FILES-CAPS"/>GNOME_VFS_APPLICATION_REGISTRY_CAN_OPEN_MULTIPLE_FILES</title>
 118 <indexterm><primary>GNOME_VFS_APPLICATION_REGISTRY_CAN_OPEN_MULTIPLE_FILES</primary></indexterm><programlisting>#define GNOME_VFS_APPLICATION_REGISTRY_CAN_OPEN_MULTIPLE_FILES "can_open_multiple_files"
 119 </programlisting>
 120 <para>
 121 Application registry key for determining if an application
 122 can open multiple files in the same invocation.</para>
 123 <para>
 124
 125 </para></refsect2>
 126 <refsect2>
 127 <title><anchor id="GNOME-VFS-APPLICATION-REGISTRY-REQUIRES-TERMINAL-CAPS"/>GNOME_VFS_APPLICATION_REGISTRY_REQUIRES_TERMINAL</title>
 128 <indexterm><primary>GNOME_VFS_APPLICATION_REGISTRY_REQUIRES_TERMINAL</primary></indexterm><programlisting>#define GNOME_VFS_APPLICATION_REGISTRY_REQUIRES_TERMINAL "requires_terminal"
 129 </programlisting>
 130 <para>
 131 Application registry key for determining if an application
 132 needs to run from within a terminal (for example, mpg123)</para>
 133 <para>
 134
 135 </para></refsect2>
 136 <refsect2>
 137 <title><anchor id="gnome-vfs-application-registry-exists"/>gnome_vfs_application_registry_exists ()</title>
 138 <indexterm><primary>gnome_vfs_application_registry_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_application_registry_exists
 139                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 140 <para>
 141 This function will return TRUE if there is an entry for <parameter>app_id</parameter> in
 142 the registry, otherwise FALSE.</para>
 143 <para>
 144
 145 </para><variablelist role="params">
 146 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 147 <listitem><simpara> an application ID
 148 </simpara></listitem></varlistentry>
 149 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the application is in the registry, FALSE if not
 150
 151 </simpara></listitem></varlistentry>
 152 </variablelist></refsect2>
 153 <refsect2>
 154 <title><anchor id="gnome-vfs-application-registry-get-keys"/>gnome_vfs_application_registry_get_keys ()</title>
 155 <indexterm><primary>gnome_vfs_application_registry_get_keys</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_application_registry_get_keys
 156                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 157 <para>
 158 This function wil return a list of strings which is the list of
 159 keys set for <parameter>app_id</parameter> in the application registry.</para>
 160 <para>
 161
 162 </para><variablelist role="params">
 163 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 164 <listitem><simpara> the application ID for which to get keys
 165 </simpara></listitem></varlistentry>
 166 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of the keys set for <parameter>app_id</parameter>
 167
 168 </simpara></listitem></varlistentry>
 169 </variablelist></refsect2>
 170 <refsect2>
 171 <title><anchor id="gnome-vfs-application-registry-peek-value"/>gnome_vfs_application_registry_peek_value ()</title>
 172 <indexterm><primary>gnome_vfs_application_registry_peek_value</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_application_registry_peek_value
 173                                             (const <link linkend="char">char</link> *app_id,
 174                                              const <link linkend="char">char</link> *key);</programlisting>
 175 <para>
 176 This will return the value associated with <parameter>key</parameter> for <parameter>app_id</parameter> in the
 177 application registry. There is no need to free the return value.</para>
 178 <para>
 179
 180 </para><variablelist role="params">
 181 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 182 <listitem><simpara> the application ID for which to look up a value
 183 </simpara></listitem></varlistentry>
 184 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 185 <listitem><simpara> the key to look up
 186 </simpara></listitem></varlistentry>
 187 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the value associated with the key, or NULL if there is no
 188 associated value
 189
 190 </simpara></listitem></varlistentry>
 191 </variablelist></refsect2>
 192 <refsect2>
 193 <title><anchor id="gnome-vfs-application-registry-get-bool-value"/>gnome_vfs_application_registry_get_bool_value ()</title>
 194 <indexterm><primary>gnome_vfs_application_registry_get_bool_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_application_registry_get_bool_value
 195                                             (const <link linkend="char">char</link> *app_id,
 196                                              const <link linkend="char">char</link> *key,
 197                                              <link linkend="gboolean">gboolean</link> *got_key);</programlisting>
 198 <para>
 199 This will look up a key in the structure pointed to by app_id and return the
 200 boolean value of that key.  It will return false if there are no
 201 applications associated with the app_id.</para>
 202 <para>
 203
 204 </para><variablelist role="params">
 205 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 206 <listitem><simpara>  registry id of the application
 207 </simpara></listitem></varlistentry>
 208 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 209 <listitem><simpara> key to look up
 210 </simpara></listitem></varlistentry>
 211 <varlistentry><term><parameter>got_key</parameter>&nbsp;:</term>
 212 <listitem><simpara> TRUE if a setting was dound, otherwise FALSE
 213 </simpara></listitem></varlistentry>
 214 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>key</parameter> is set to "true" or "yes" for <parameter>app_id</parameter>, otherwise FALSE
 215
 216 </simpara></listitem></varlistentry>
 217 </variablelist></refsect2>
 218 <refsect2>
 219 <title><anchor id="gnome-vfs-application-registry-remove-application"/>gnome_vfs_application_registry_remove_application ()</title>
 220 <indexterm><primary>gnome_vfs_application_registry_remove_application</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_remove_application
 221                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 222 <para>
 223 Given the registry id this function will remove all applications that has
 224 been set by the user.  You will need to call
 225 gnome_vfs_application_registry_sync to save the changes.</para>
 226 <para>
 227
 228 </para><variablelist role="params">
 229 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 230 <listitem><simpara>  registry id of the application
 231 </simpara></listitem></varlistentry>
 232 </variablelist></refsect2>
 233 <refsect2>
 234 <title><anchor id="gnome-vfs-application-registry-set-value"/>gnome_vfs_application_registry_set_value ()</title>
 235 <indexterm><primary>gnome_vfs_application_registry_set_value</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_set_value
 236                                             (const <link linkend="char">char</link> *app_id,
 237                                              const <link linkend="char">char</link> *key,
 238                                              const <link linkend="char">char</link> *value);</programlisting>
 239 <para>
 240 This function will set values pertaining to registry entry pointed to by
 241 app_id.  You will need to call gnome_vfs_application_registry_sync to
 242 realize the changes.</para>
 243 <para>
 244
 245 </para><variablelist role="params">
 246 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 247 <listitem><simpara>  registry id of the application
 248 </simpara></listitem></varlistentry>
 249 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 250 <listitem><simpara> target key
 251 </simpara></listitem></varlistentry>
 252 <varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 253 <listitem><simpara> value to set the target key to
 254 </simpara></listitem></varlistentry>
 255 </variablelist></refsect2>
 256 <refsect2>
 257 <title><anchor id="gnome-vfs-application-registry-set-bool-value"/>gnome_vfs_application_registry_set_bool_value ()</title>
 258 <indexterm><primary>gnome_vfs_application_registry_set_bool_value</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_set_bool_value
 259                                             (const <link linkend="char">char</link> *app_id,
 260                                              const <link linkend="char">char</link> *key,
 261                                              <link linkend="gboolean">gboolean</link> value);</programlisting>
 262 <para>
 263 This function will modify those registry values that are of type boolean to
 264 a value specified by the user.  You will need to call
 265 gnome_vfs_application_registry_sync to save your changes.</para>
 266 <para>
 267
 268 </para><variablelist role="params">
 269 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 270 <listitem><simpara>  registry id of the application
 271 </simpara></listitem></varlistentry>
 272 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 273 <listitem><simpara> target key
 274 </simpara></listitem></varlistentry>
 275 <varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 276 <listitem><simpara> value you want to set the target key to
 277 </simpara></listitem></varlistentry>
 278 </variablelist></refsect2>
 279 <refsect2>
 280 <title><anchor id="gnome-vfs-application-registry-unset-key"/>gnome_vfs_application_registry_unset_key ()</title>
 281 <indexterm><primary>gnome_vfs_application_registry_unset_key</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_unset_key
 282                                             (const <link linkend="char">char</link> *app_id,
 283                                              const <link linkend="char">char</link> *key);</programlisting>
 284 <para>
 285 This function given the application and the target will wipe the current
 286 value that the key contains.</para>
 287 <para>
 288
 289 </para><variablelist role="params">
 290 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 291 <listitem><simpara> registry id of the application
 292 </simpara></listitem></varlistentry>
 293 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 294 <listitem><simpara> search key
 295 </simpara></listitem></varlistentry>
 296 </variablelist></refsect2>
 297 <refsect2>
 298 <title><anchor id="gnome-vfs-application-registry-get-applications"/>gnome_vfs_application_registry_get_applications ()</title>
 299 <indexterm><primary>gnome_vfs_application_registry_get_applications</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_application_registry_get_applications
 300                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 301 <para>
 302 This will return all applications from the registry that are associated with
 303 the given mime type string, if NULL it returns all applications.</para>
 304 <para>
 305
 306 </para><variablelist role="params">
 307 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 308 <listitem><simpara>  mime type string
 309 </simpara></listitem></varlistentry>
 310 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of the application IDs for all applications which
 311 support the given mime type.
 312
 313 </simpara></listitem></varlistentry>
 314 </variablelist></refsect2>
 315 <refsect2>
 316 <title><anchor id="gnome-vfs-application-registry-get-mime-types"/>gnome_vfs_application_registry_get_mime_types ()</title>
 317 <indexterm><primary>gnome_vfs_application_registry_get_mime_types</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_application_registry_get_mime_types
 318                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 319 <para>
 320 This function returns a list of strings that represent the mime
 321 types that can be handled by an application.</para>
 322 <para>
 323
 324 </para><variablelist role="params">
 325 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 326 <listitem><simpara> registry id of application
 327 </simpara></listitem></varlistentry>
 328 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of the mime types supported
 329
 330 </simpara></listitem></varlistentry>
 331 </variablelist></refsect2>
 332 <refsect2>
 333 <title><anchor id="gnome-vfs-application-registry-supports-mime-type"/>gnome_vfs_application_registry_supports_mime_type ()</title>
 334 <indexterm><primary>gnome_vfs_application_registry_supports_mime_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_application_registry_supports_mime_type
 335                                             (const <link linkend="char">char</link> *app_id,
 336                                              const <link linkend="char">char</link> *mime_type);</programlisting>
 337 <para>
 338 Use this function to see if there is an application associated with a given
 339 mime type.  The function will return true or false.</para>
 340 <para>
 341
 342 </para><variablelist role="params">
 343 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 344 <listitem><simpara> registry id of application
 345 </simpara></listitem></varlistentry>
 346 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 347 <listitem><simpara> mime type string
 348 </simpara></listitem></varlistentry>
 349 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>app_id</parameter> supports <parameter>mime_type</parameter>, otherwise FALSE.
 350
 351 </simpara></listitem></varlistentry>
 352 </variablelist></refsect2>
 353 <refsect2>
 354 <title><anchor id="gnome-vfs-application-registry-supports-uri-scheme"/>gnome_vfs_application_registry_supports_uri_scheme ()</title>
 355 <indexterm><primary>gnome_vfs_application_registry_supports_uri_scheme</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_application_registry_supports_uri_scheme
 356                                             (const <link linkend="char">char</link> *app_id,
 357                                              const <link linkend="char">char</link> *uri_scheme);</programlisting>
 358 <para>
 359 Given the id of the application this function will determine if the
 360 uri scheme will given is supported.</para>
 361 <para>
 362
 363 </para><variablelist role="params">
 364 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 365 <listitem><simpara> registry id of application
 366 </simpara></listitem></varlistentry>
 367 <varlistentry><term><parameter>uri_scheme</parameter>&nbsp;:</term>
 368 <listitem><simpara> uri schme string
 369 </simpara></listitem></varlistentry>
 370 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>app_id</parameter> supports <parameter>uri_scheme</parameter>, otherwise FALSE
 371
 372 </simpara></listitem></varlistentry>
 373 </variablelist></refsect2>
 374 <refsect2>
 375 <title><anchor id="gnome-vfs-application-is-user-owned-application"/>gnome_vfs_application_is_user_owned_application ()</title>
 376 <indexterm><primary>gnome_vfs_application_is_user_owned_application</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_application_is_user_owned_application
 377                                             (const <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);</programlisting>
 378 <para>
 379 This function will determine if a mime application is user owned or not.  By
 380 user ownered this means that the application is not a system application
 381 located in the prerequisite /usr area but rather in the user's area.</para>
 382 <para>
 383
 384 </para><variablelist role="params">
 385 <varlistentry><term><parameter>application</parameter>&nbsp;:</term>
 386 <listitem><simpara>  data structure of the mime application
 387 </simpara></listitem></varlistentry>
 388 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> gboolean
 389 </simpara></listitem></varlistentry>
 390 </variablelist></refsect2>
 391 <refsect2>
 392 <title><anchor id="gnome-vfs-application-registry-clear-mime-types"/>gnome_vfs_application_registry_clear_mime_types ()</title>
 393 <indexterm><primary>gnome_vfs_application_registry_clear_mime_types</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_clear_mime_types
 394                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 395 <para>
 396 This function will remove the mime types associated with the application.
 397 Changes are not realized until the  gnome_vfs_application_registry_sync
 398 function is called to save the changes to the file.</para>
 399 <para>
 400
 401 </para><variablelist role="params">
 402 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 403 <listitem><simpara> Application id
 404 </simpara></listitem></varlistentry>
 405 </variablelist></refsect2>
 406 <refsect2>
 407 <title><anchor id="gnome-vfs-application-registry-add-mime-type"/>gnome_vfs_application_registry_add_mime_type ()</title>
 408 <indexterm><primary>gnome_vfs_application_registry_add_mime_type</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_add_mime_type
 409                                             (const <link linkend="char">char</link> *app_id,
 410                                              const <link linkend="char">char</link> *mime_type);</programlisting>
 411 <para>
 412 This function will associate a mime type with an application given the
 413 application registry id and the mime type.  Changes are not realized until
 414 the gnome_vfs_application_registry_sync function is called to save the
 415 changes to the file.</para>
 416 <para>
 417
 418 </para><variablelist role="params">
 419 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 420 <listitem><simpara> registry id of application
 421 </simpara></listitem></varlistentry>
 422 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 423 <listitem><simpara> mime type string
 424 </simpara></listitem></varlistentry>
 425 </variablelist></refsect2>
 426 <refsect2>
 427 <title><anchor id="gnome-vfs-application-registry-remove-mime-type"/>gnome_vfs_application_registry_remove_mime_type ()</title>
 428 <indexterm><primary>gnome_vfs_application_registry_remove_mime_type</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_remove_mime_type
 429                                             (const <link linkend="char">char</link> *app_id,
 430                                              const <link linkend="char">char</link> *mime_type);</programlisting>
 431 <para>
 432 This function will de-associate a mime type from an application registry.
 433 Given the application registry id and the mime type.  Changes are not
 434 realized until the gnome_vfs_application_registry_sync function is called to
 435 save the changes to the file.</para>
 436 <para>
 437
 438 </para><variablelist role="params">
 439 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 440 <listitem><simpara> registry id of the application
 441 </simpara></listitem></varlistentry>
 442 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 443 <listitem><simpara> mime type string
 444 </simpara></listitem></varlistentry>
 445 </variablelist></refsect2>
 446 <refsect2>
 447 <title><anchor id="gnome-vfs-application-registry-sync"/>gnome_vfs_application_registry_sync ()</title>
 448 <indexterm><primary>gnome_vfs_application_registry_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_application_registry_sync
 449                                             (void);</programlisting>
 450 <para>
 451 This function will sync the registry.  Typically you would use this function
 452 after a modification of the registry.  When you modify the registry a dirty
 453 flag is set.  Calling this function will save your modifications to disk and
 454 reset the flag.
 455 </para>
 456 <para>
 457 If successful, will return GNOME_VFS_OK</para>
 458 <para>
 459
 460 </para><variablelist role="params">
 461 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult
 462
 463 </simpara></listitem></varlistentry>
 464 </variablelist></refsect2>
 465 <refsect2>
 466 <title><anchor id="gnome-vfs-application-registry-shutdown"/>gnome_vfs_application_registry_shutdown ()</title>
 467 <indexterm><primary>gnome_vfs_application_registry_shutdown</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_shutdown
 468                                             (void);</programlisting>
 469 <para>
 470 Synchronize gnome-vfs application registry data to disk, and free
 471 resources.</para>
 472 <para>
 473
 474 </para></refsect2>
 475 <refsect2>
 476 <title><anchor id="gnome-vfs-application-registry-reload"/>gnome_vfs_application_registry_reload ()</title>
 477 <indexterm><primary>gnome_vfs_application_registry_reload</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_reload
 478                                             (void);</programlisting>
 479 <para>
 480 If this function is called for the first time it will initialize the
 481 registry.  Subsequent calls to the function will clear out the current
 482 registry contents and load registry contents from the save file.  Make
 483 certain that you've saved your registry before calling this function.  It
 484 will destroy unsaved changes.</para>
 485 <para>
 486
 487 </para></refsect2>
 488 <refsect2>
 489 <title><anchor id="gnome-vfs-application-registry-get-mime-application"/>gnome_vfs_application_registry_get_mime_application ()</title>
 490 <indexterm><primary>gnome_vfs_application_registry_get_mime_application</primary></indexterm><programlisting><link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* gnome_vfs_application_registry_get_mime_application
 491                                             (const <link linkend="char">char</link> *app_id);</programlisting>
 492 <para>
 493 Returns a structure that contains the application that handles
 494 the mime type associated by the application referred by app_id.</para>
 495 <para>
 496
 497 </para><variablelist role="params">
 498 <varlistentry><term><parameter>app_id</parameter>&nbsp;:</term>
 499 <listitem><simpara>  registry id of the application
 500 </simpara></listitem></varlistentry>
 501 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSMimeApplication
 502
 503 </simpara></listitem></varlistentry>
 504 </variablelist></refsect2>
 505 <refsect2>
 506 <title><anchor id="gnome-vfs-application-registry-save-mime-application"/>gnome_vfs_application_registry_save_mime_application ()</title>
 507 <indexterm><primary>gnome_vfs_application_registry_save_mime_application</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_application_registry_save_mime_application
 508                                             (const <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);</programlisting>
 509 <para>
 510 This will save to the registry the application that will be associated with
 511 a defined mime type.  The defined mime type is located within the
 512 GnomeVFSMimeApplication structure.  Changes are not realized until the
 513 gnome_vfs_application_registry_sync function is called.</para>
 514 <para>
 515
 516 </para><variablelist role="params">
 517 <varlistentry><term><parameter>application</parameter>&nbsp;:</term>
 518 <listitem><simpara> application associated with the mime type
 519 </simpara></listitem></varlistentry>
 520 </variablelist></refsect2>
 521
 522 </refsect1>
 523
 524
 525
 526
 527 </refentry>