doc/xml/gnome-vfs-result.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-result">
   2 <refmeta>
   3 <refentrytitle>GnomeVFSResult</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>GnomeVFSResult</refname><refpurpose>
  10 Result of I/O operations, the equivalent of errno</refpurpose>
  11 </refnamediv>
  12
  13 <refsynopsisdiv><title>Synopsis</title>
  14
  15 <synopsis>
  16
  17
  18
  19 enum        <link linkend="GnomeVFSResult">GnomeVFSResult</link>;
  20 const <link linkend="char">char</link>* <link linkend="gnome-vfs-result-to-string">gnome_vfs_result_to_string</link>      (<link linkend="GnomeVFSResult">GnomeVFSResult</link> result);
  21 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-result-from-errno-code">gnome_vfs_result_from_errno_code</link>
  22                                             (<link linkend="int">int</link> errno_code);
  23 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-result-from-errno">gnome_vfs_result_from_errno</link>  (void);
  24 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-result-from-h-errno">gnome_vfs_result_from_h_errno</link>
  25                                             (void);
  26 </synopsis>
  27 </refsynopsisdiv>
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37 <refsect1>
  38 <title>Description</title>
  39 <para>
  40
  41 </para>
  42 </refsect1>
  43
  44 <refsect1>
  45 <title>Details</title>
  46 <refsect2>
  47 <title><anchor id="GnomeVFSResult"/>enum GnomeVFSResult</title>
  48 <indexterm><primary>GnomeVFSResult</primary></indexterm><programlisting>typedef enum {
  49         GNOME_VFS_OK,
  50         GNOME_VFS_ERROR_NOT_FOUND,
  51         GNOME_VFS_ERROR_GENERIC,
  52         GNOME_VFS_ERROR_INTERNAL,
  53         GNOME_VFS_ERROR_BAD_PARAMETERS,
  54         GNOME_VFS_ERROR_NOT_SUPPORTED,
  55         GNOME_VFS_ERROR_IO,
  56         GNOME_VFS_ERROR_CORRUPTED_DATA,
  57         GNOME_VFS_ERROR_WRONG_FORMAT,
  58         GNOME_VFS_ERROR_BAD_FILE,
  59         GNOME_VFS_ERROR_TOO_BIG,
  60         GNOME_VFS_ERROR_NO_SPACE,
  61         GNOME_VFS_ERROR_READ_ONLY,
  62         GNOME_VFS_ERROR_INVALID_URI,
  63         GNOME_VFS_ERROR_NOT_OPEN,
  64         GNOME_VFS_ERROR_INVALID_OPEN_MODE,
  65         GNOME_VFS_ERROR_ACCESS_DENIED,
  66         GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES,
  67         GNOME_VFS_ERROR_EOF,
  68         GNOME_VFS_ERROR_NOT_A_DIRECTORY,
  69         GNOME_VFS_ERROR_IN_PROGRESS,
  70         GNOME_VFS_ERROR_INTERRUPTED,
  71         GNOME_VFS_ERROR_FILE_EXISTS,
  72         GNOME_VFS_ERROR_LOOP,
  73         GNOME_VFS_ERROR_NOT_PERMITTED,
  74         GNOME_VFS_ERROR_IS_DIRECTORY,
  75         GNOME_VFS_ERROR_NO_MEMORY,
  76         GNOME_VFS_ERROR_HOST_NOT_FOUND,
  77         GNOME_VFS_ERROR_INVALID_HOST_NAME,
  78         GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS,
  79         GNOME_VFS_ERROR_LOGIN_FAILED,
  80         GNOME_VFS_ERROR_CANCELLED,
  81         GNOME_VFS_ERROR_DIRECTORY_BUSY,
  82         GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY,
  83         GNOME_VFS_ERROR_TOO_MANY_LINKS,
  84         GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM,
  85         GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM,
  86         GNOME_VFS_ERROR_NAME_TOO_LONG,
  87         GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE,
  88         GNOME_VFS_ERROR_SERVICE_OBSOLETE,
  89         GNOME_VFS_ERROR_PROTOCOL_ERROR,
  90         GNOME_VFS_ERROR_NO_MASTER_BROWSER,
  91         GNOME_VFS_ERROR_NO_DEFAULT,
  92         GNOME_VFS_ERROR_NO_HANDLER,
  93         GNOME_VFS_ERROR_PARSE,
  94         GNOME_VFS_ERROR_LAUNCH,
  95         GNOME_VFS_NUM_ERRORS
  96 } GnomeVFSResult;
  97 </programlisting>
  98 <para>
  99
 100 </para></refsect2>
 101 <refsect2>
 102 <title><anchor id="gnome-vfs-result-to-string"/>gnome_vfs_result_to_string ()</title>
 103 <indexterm><primary>gnome_vfs_result_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_result_to_string      (<link linkend="GnomeVFSResult">GnomeVFSResult</link> result);</programlisting>
 104 <para>
 105 Returns a string representation of <parameter>result</parameter>, useful for debugging
 106 purposes, but probably not appropriate for passing to the user.</para>
 107 <para>
 108
 109 </para><variablelist role="params">
 110 <varlistentry><term><parameter>result</parameter>&nbsp;:</term>
 111 <listitem><simpara> the result to convert to a string
 112 </simpara></listitem></varlistentry>
 113 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string representing <parameter>result</parameter>
 114 </simpara></listitem></varlistentry>
 115 </variablelist></refsect2>
 116 <refsect2>
 117 <title><anchor id="gnome-vfs-result-from-errno-code"/>gnome_vfs_result_from_errno_code ()</title>
 118 <indexterm><primary>gnome_vfs_result_from_errno_code</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_result_from_errno_code
 119                                             (<link linkend="int">int</link> errno_code);</programlisting>
 120 <para>
 121 Converts a system errno value to a GnomeVFSResult.</para>
 122 <para>
 123
 124 </para><variablelist role="params">
 125 <varlistentry><term><parameter>errno_code</parameter>&nbsp;:</term>
 126 <listitem><simpara> integer of the same type as the system "errno"
 127 </simpara></listitem></varlistentry>
 128 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GnomeVFSResult equivalent to <parameter>errno_code</parameter>
 129 </simpara></listitem></varlistentry>
 130 </variablelist></refsect2>
 131 <refsect2>
 132 <title><anchor id="gnome-vfs-result-from-errno"/>gnome_vfs_result_from_errno ()</title>
 133 <indexterm><primary>gnome_vfs_result_from_errno</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_result_from_errno  (void);</programlisting>
 134 <para>
 135 Converts the system errno to a GnomeVFSResult.</para>
 136 <para>
 137
 138 </para><variablelist role="params">
 139 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GnomeVFSResult equivalent to the current system errno
 140 </simpara></listitem></varlistentry>
 141 </variablelist></refsect2>
 142 <refsect2>
 143 <title><anchor id="gnome-vfs-result-from-h-errno"/>gnome_vfs_result_from_h_errno ()</title>
 144 <indexterm><primary>gnome_vfs_result_from_h_errno</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_result_from_h_errno
 145                                             (void);</programlisting>
 146 <para>
 147 Converts the system "h_errno" to a GnomeVFSResult (h_errno represents errors
 148 accessing and finding internet hosts)</para>
 149 <para>
 150
 151 </para><variablelist role="params">
 152 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GnomeVFSResult equivalent to the current system "h_errno"
 153 </simpara></listitem></varlistentry>
 154 </variablelist></refsect2>
 155
 156 </refsect1>
 157
 158
 159
 160
 161 </refentry>