ftp://ftp.redhat.com/pub/redhat/linux/rawhide/SRPMS/SRPMS/gnome-vfs2-2.3.8-1.src.rpm
[gnome-vfs-httpcaptive.git] / doc / html / gnome-vfs-20-gnome-vfs-result.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GnomeVFSResult</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
2         .synopsis, .classsynopsis {
3             background: #eeeeee;
4             border: solid 1px #aaaaaa;
5             padding: 0.5em;
6         }
7         .programlisting {
8             background: #eeeeff;
9             border: solid 1px #aaaaff;
10             padding: 0.5em;
11         }
12         .variablelist {
13             padding: 4px;
14             margin-left: 3em;
15         }
16         .navigation {
17             background: #ffeeee;
18             border: solid 1px #ffaaaa;
19             margin-top: 0.5em;
20             margin-bottom: 0.5em;
21         }
22         .navigation a {
23             color: #770000;
24         }
25         .navigation a:visited {
26             color: #550000;
27         }
28         .navigation .title {
29             font-size: 200%;
30         }
31       </style><link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library"><link rel="up" href="data-types.html" title="Data Types"><link rel="previous" href="gnome-vfs-20-gnome-vfs-file-size.html" title="GnomeVFSFileSize"><link rel="next" href="gnome-vfs-20-gnome-vfs-uri.html" title="GnomeVFSURI"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-file-size.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="data-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th><td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-uri.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gnome-vfs-20-gnome-vfs-result"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">GnomeVFSResult</span></h2><p>GnomeVFSResult &#8212; 
32 Result of I/O operations, the equivalent of errno</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
33
34
35
36 enum        <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a>;
37 const char* <a href="gnome-vfs-20-gnome-vfs-result.html#gnome-vfs-result-to-string">gnome_vfs_result_to_string</a>      (<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> result);
38 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-result.html#gnome-vfs-result-from-errno-code">gnome_vfs_result_from_errno_code</a>
39                                             (int errno_code);
40 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-result.html#gnome-vfs-result-from-errno">gnome_vfs_result_from_errno</a>  (void);
41 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-result.html#gnome-vfs-result-from-h-errno">gnome_vfs_result_from_h_errno</a>
42                                             (void);
43 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
44
45 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GnomeVFSResult"></a>enum GnomeVFSResult</h3><a class="indexterm" name="id2934160"></a><pre class="programlisting">typedef enum {
46         GNOME_VFS_OK,
47         GNOME_VFS_ERROR_NOT_FOUND,
48         GNOME_VFS_ERROR_GENERIC,
49         GNOME_VFS_ERROR_INTERNAL,
50         GNOME_VFS_ERROR_BAD_PARAMETERS,
51         GNOME_VFS_ERROR_NOT_SUPPORTED,
52         GNOME_VFS_ERROR_IO,
53         GNOME_VFS_ERROR_CORRUPTED_DATA,
54         GNOME_VFS_ERROR_WRONG_FORMAT,
55         GNOME_VFS_ERROR_BAD_FILE,
56         GNOME_VFS_ERROR_TOO_BIG,
57         GNOME_VFS_ERROR_NO_SPACE,
58         GNOME_VFS_ERROR_READ_ONLY,
59         GNOME_VFS_ERROR_INVALID_URI,
60         GNOME_VFS_ERROR_NOT_OPEN,
61         GNOME_VFS_ERROR_INVALID_OPEN_MODE,
62         GNOME_VFS_ERROR_ACCESS_DENIED,
63         GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES,
64         GNOME_VFS_ERROR_EOF,
65         GNOME_VFS_ERROR_NOT_A_DIRECTORY,
66         GNOME_VFS_ERROR_IN_PROGRESS,
67         GNOME_VFS_ERROR_INTERRUPTED,
68         GNOME_VFS_ERROR_FILE_EXISTS,
69         GNOME_VFS_ERROR_LOOP,
70         GNOME_VFS_ERROR_NOT_PERMITTED,
71         GNOME_VFS_ERROR_IS_DIRECTORY,
72         GNOME_VFS_ERROR_NO_MEMORY,
73         GNOME_VFS_ERROR_HOST_NOT_FOUND,
74         GNOME_VFS_ERROR_INVALID_HOST_NAME,
75         GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS,
76         GNOME_VFS_ERROR_LOGIN_FAILED,
77         GNOME_VFS_ERROR_CANCELLED,
78         GNOME_VFS_ERROR_DIRECTORY_BUSY,
79         GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY,
80         GNOME_VFS_ERROR_TOO_MANY_LINKS,
81         GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM,
82         GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM,
83         GNOME_VFS_ERROR_NAME_TOO_LONG,
84         GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE,
85         GNOME_VFS_ERROR_SERVICE_OBSOLETE,
86         GNOME_VFS_ERROR_PROTOCOL_ERROR,
87         GNOME_VFS_ERROR_NO_MASTER_BROWSER,
88         GNOME_VFS_ERROR_NO_DEFAULT,
89         GNOME_VFS_ERROR_NO_HANDLER,
90         GNOME_VFS_ERROR_PARSE,
91         GNOME_VFS_ERROR_LAUNCH,
92         GNOME_VFS_NUM_ERRORS
93 } GnomeVFSResult;
94 </pre><p>
95  
96 </p></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-result-to-string"></a>gnome_vfs_result_to_string ()</h3><a class="indexterm" name="id2934912"></a><pre class="programlisting">const char* gnome_vfs_result_to_string      (<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> result);</pre><p>
97 Returns a string representation of <i class="parameter"><tt>result</tt></i>, useful for debugging
98 purposes, but probably not appropriate for passing to the user.</p><p>
99
100 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>result</tt></i> :</span></td><td> the result to convert to a string
101 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a string representing <i class="parameter"><tt>result</tt></i>
102 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-result-from-errno-code"></a>gnome_vfs_result_from_errno_code ()</h3><a class="indexterm" name="id2935017"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_result_from_errno_code
103                                             (int errno_code);</pre><p>
104 Converts a system errno value to a GnomeVFSResult.</p><p>
105
106 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>errno_code</tt></i> :</span></td><td> integer of the same type as the system "errno"
107 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a GnomeVFSResult equivalent to <i class="parameter"><tt>errno_code</tt></i>
108 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-result-from-errno"></a>gnome_vfs_result_from_errno ()</h3><a class="indexterm" name="id2936190"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_result_from_errno  (void);</pre><p>
109 Converts the system errno to a GnomeVFSResult.</p><p>
110
111 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a GnomeVFSResult equivalent to the current system errno
112 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-result-from-h-errno"></a>gnome_vfs_result_from_h_errno ()</h3><a class="indexterm" name="id2936254"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_result_from_h_errno
113                                             (void);</pre><p>
114 Converts the system "h_errno" to a GnomeVFSResult (h_errno represents errors
115 accessing and finding internet hosts)</p><p>
116
117 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a GnomeVFSResult equivalent to the current system "h_errno"
118 </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gnome-vfs-20-gnome-vfs-file-size.html"><b>&lt;&lt; GnomeVFSFileSize</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-uri.html"><b>GnomeVFSURI &gt;&gt;</b></a></td></tr></table></body></html>