46
<refsect1 id="gnome-vfs-20-gnome-vfs-resolve.description" role="desc">
46
<refsect1 id="gnome-vfs-2.0-gnome-vfs-resolve.description" role="desc">
47
47
<title role="desc.title">Description</title>
52
<refsect1 id="gnome-vfs-20-gnome-vfs-resolve.details" role="details">
53
<refsect1 id="gnome-vfs-2.0-gnome-vfs-resolve.details" role="details">
53
54
<title role="details.title">Details</title>
54
55
<refsect2 id="gnome-vfs-resolve" role="function" condition="since:2.8">
55
56
<title>gnome_vfs_resolve ()</title>
56
<indexterm zone="gnome-vfs-resolve" role="2.8"><primary sortas="gnome_vfs_resolve">gnome_vfs_resolve</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_resolve (const <link linkend="char">char</link> *hostname,
57
<indexterm zone="gnome-vfs-resolve" role="2.8"><primary>gnome_vfs_resolve</primary></indexterm>
58
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_resolve (const <link linkend="char">char</link> *hostname,
57
59
<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> **handle);</programlisting>
59
61
Tries to resolve <parameter>hostname</parameter>. If the operation was successful you can
65
67
<listitem><simpara> hostname you want to resolve.
66
68
</simpara></listitem></varlistentry>
67
69
<varlistentry><term><parameter>handle</parameter> :</term>
68
<listitem><simpara> pointer to a pointer to a <link linkend="GnomeVFSResolveHandle"><type>GnomeVFSResolveHandle</type></link>.
70
<listitem><simpara> pointer to a pointer to a <link linkend="GnomeVFSResolveHandle."><type>GnomeVFSResolveHandle.</type></link>
69
71
</simpara></listitem></varlistentry>
70
72
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link> indicating the success of the operation.
73
75
</variablelist><para role="since">Since 2.8</para></refsect2>
74
76
<refsect2 id="gnome-vfs-resolve-free" role="function" condition="since:2.8">
75
77
<title>gnome_vfs_resolve_free ()</title>
76
<indexterm zone="gnome-vfs-resolve-free" role="2.8"><primary sortas="gnome_vfs_resolve_free">gnome_vfs_resolve_free</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_resolve_free (<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> *handle);</programlisting>
78
<indexterm zone="gnome-vfs-resolve-free" role="2.8"><primary>gnome_vfs_resolve_free</primary></indexterm>
79
<programlisting><link linkend="void">void</link> gnome_vfs_resolve_free (<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> *handle);</programlisting>
78
81
Use this function to free a <link linkend="GnomeVFSResolveHandle"><type>GnomeVFSResolveHandle</type></link> returned by
79
82
<link linkend="gnome-vfs-resolve"><function>gnome_vfs_resolve()</function></link>.</para>
81
84
</para><variablelist role="params">
82
85
<varlistentry><term><parameter>handle</parameter> :</term>
83
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle"><type>GnomeVFSResolveHandle</type></link>.
86
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle."><type>GnomeVFSResolveHandle.</type></link>
84
87
</simpara></listitem></varlistentry>
85
88
</variablelist><para role="since">Since 2.8</para></refsect2>
86
89
<refsect2 id="gnome-vfs-resolve-next-address" role="function" condition="since:2.8">
87
90
<title>gnome_vfs_resolve_next_address ()</title>
88
<indexterm zone="gnome-vfs-resolve-next-address" role="2.8"><primary sortas="gnome_vfs_resolve_next_address">gnome_vfs_resolve_next_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_vfs_resolve_next_address (<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> *handle,
91
<indexterm zone="gnome-vfs-resolve-next-address" role="2.8"><primary>gnome_vfs_resolve_next_address</primary></indexterm>
92
<programlisting><link linkend="gboolean">gboolean</link> gnome_vfs_resolve_next_address (<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> *handle,
89
93
<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> **address);</programlisting>
91
95
Stores the next <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link> available in <parameter>handle</parameter> of the
94
98
</para><variablelist role="params">
95
99
<varlistentry><term><parameter>handle</parameter> :</term>
96
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle"><type>GnomeVFSResolveHandle</type></link>.
100
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle."><type>GnomeVFSResolveHandle.</type></link>
97
101
</simpara></listitem></varlistentry>
98
102
<varlistentry><term><parameter>address</parameter> :</term>
99
<listitem><simpara> a pointer to a pointer to a <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
103
<listitem><simpara> a pointer to a pointer to a <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
100
104
</simpara></listitem></varlistentry>
101
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the next address was stored in <parameter>address</parameter> or
102
<link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if no other address is available.
105
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the next address was stored in <parameter>address</parameter> or
106
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if no other address is available.
104
108
</simpara></listitem></varlistentry>
105
109
</variablelist><para role="since">Since 2.8</para></refsect2>
106
110
<refsect2 id="gnome-vfs-resolve-reset-to-beginning" role="function" condition="since:2.8">
107
111
<title>gnome_vfs_resolve_reset_to_beginning ()</title>
108
<indexterm zone="gnome-vfs-resolve-reset-to-beginning" role="2.8"><primary sortas="gnome_vfs_resolve_reset_to_beginning">gnome_vfs_resolve_reset_to_beginning</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_resolve_reset_to_beginning
112
<indexterm zone="gnome-vfs-resolve-reset-to-beginning" role="2.8"><primary>gnome_vfs_resolve_reset_to_beginning</primary></indexterm>
113
<programlisting><link linkend="void">void</link> gnome_vfs_resolve_reset_to_beginning
109
114
(<link linkend="GnomeVFSResolveHandle">GnomeVFSResolveHandle</link> *handle);</programlisting>
111
116
Reset <parameter>handle</parameter> so that a following call to <link linkend="gnome-vfs-resolve-next-address"><function>gnome_vfs_resolve_next_address()</function></link>
114
119
</para><variablelist role="params">
115
120
<varlistentry><term><parameter>handle</parameter> :</term>
116
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle"><type>GnomeVFSResolveHandle</type></link>.
121
<listitem><simpara> a <link linkend="GnomeVFSResolveHandle."><type>GnomeVFSResolveHandle.</type></link>
117
122
</simpara></listitem></varlistentry>
118
123
</variablelist><para role="since">Since 2.8</para></refsect2>
119
124
<refsect2 id="GnomeVFSAddress" role="struct">
120
125
<title>GnomeVFSAddress</title>
121
<indexterm zone="GnomeVFSAddress"><primary sortas="GnomeVFSAddress">GnomeVFSAddress</primary></indexterm><programlisting>typedef struct _GnomeVFSAddress GnomeVFSAddress;</programlisting>
126
<indexterm zone="GnomeVFSAddress"><primary>GnomeVFSAddress</primary></indexterm>
127
<programlisting>typedef struct _GnomeVFSAddress GnomeVFSAddress;</programlisting>
123
129
</para></refsect2>
124
130
<refsect2 id="gnome-vfs-address-dup" role="function" condition="since:2.8">
125
131
<title>gnome_vfs_address_dup ()</title>
126
<indexterm zone="gnome-vfs-address-dup" role="2.8"><primary sortas="gnome_vfs_address_dup">gnome_vfs_address_dup</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_dup (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
132
<indexterm zone="gnome-vfs-address-dup" role="2.8"><primary>gnome_vfs_address_dup</primary></indexterm>
133
<programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_dup (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
128
135
Duplicates <parameter>address</parameter>.</para>
130
137
</para><variablelist role="params">
131
138
<varlistentry><term><parameter>address</parameter> :</term>
132
<listitem><simpara> A <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
139
<listitem><simpara> A <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
133
140
</simpara></listitem></varlistentry>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Duplicated <parameter>address</parameter> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>address</parameter> was not valid.
141
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Duplicated <parameter>address</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>address</parameter> was not valid.
136
143
</simpara></listitem></varlistentry>
137
144
</variablelist><para role="since">Since 2.8</para></refsect2>
138
145
<refsect2 id="gnome-vfs-address-free" role="function" condition="since:2.8">
139
146
<title>gnome_vfs_address_free ()</title>
140
<indexterm zone="gnome-vfs-address-free" role="2.8"><primary sortas="gnome_vfs_address_free">gnome_vfs_address_free</primary></indexterm><programlisting><link linkend="void">void</link> gnome_vfs_address_free (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
147
<indexterm zone="gnome-vfs-address-free" role="2.8"><primary>gnome_vfs_address_free</primary></indexterm>
148
<programlisting><link linkend="void">void</link> gnome_vfs_address_free (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
142
150
Frees the memory allocated for <parameter>address</parameter>.</para>
144
152
</para><variablelist role="params">
145
153
<varlistentry><term><parameter>address</parameter> :</term>
146
<listitem><simpara> A <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
154
<listitem><simpara> A <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
147
155
</simpara></listitem></varlistentry>
148
156
</variablelist><para role="since">Since 2.8</para></refsect2>
149
157
<refsect2 id="gnome-vfs-address-get-family-type" role="function" condition="since:2.8">
150
158
<title>gnome_vfs_address_get_family_type ()</title>
151
<indexterm zone="gnome-vfs-address-get-family-type" role="2.8"><primary sortas="gnome_vfs_address_get_family_type">gnome_vfs_address_get_family_type</primary></indexterm><programlisting><link linkend="int">int</link> gnome_vfs_address_get_family_type (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
159
<indexterm zone="gnome-vfs-address-get-family-type" role="2.8"><primary>gnome_vfs_address_get_family_type</primary></indexterm>
160
<programlisting><link linkend="int">int</link> gnome_vfs_address_get_family_type (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
153
162
Use this function to retrive the address family of <parameter>address</parameter>.</para>
162
171
</variablelist><para role="since">Since 2.8</para></refsect2>
163
172
<refsect2 id="gnome-vfs-address-get-ipv4" role="function" condition="since:2.8">
164
173
<title>gnome_vfs_address_get_ipv4 ()</title>
165
<indexterm zone="gnome-vfs-address-get-ipv4" role="2.8"><primary sortas="gnome_vfs_address_get_ipv4">gnome_vfs_address_get_ipv4</primary></indexterm><programlisting><link linkend="guint32">guint32</link> gnome_vfs_address_get_ipv4 (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
174
<indexterm zone="gnome-vfs-address-get-ipv4" role="2.8"><primary>gnome_vfs_address_get_ipv4</primary></indexterm>
175
<programlisting><link linkend="guint32">guint32</link> gnome_vfs_address_get_ipv4 (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
169
177
</para><variablelist role="params">
170
178
<varlistentry><term><parameter>address</parameter> :</term>
171
<listitem><simpara> A <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
179
<listitem><simpara> A <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
172
180
</simpara></listitem></varlistentry>
173
181
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The associated IPv4 address in network byte order.
179
187
</variablelist><para role="since">Since 2.8</para></refsect2>
180
188
<refsect2 id="gnome-vfs-address-get-type" role="function">
181
189
<title>gnome_vfs_address_get_type ()</title>
182
<indexterm zone="gnome-vfs-address-get-type"><primary sortas="gnome_vfs_address_get_type">gnome_vfs_address_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> gnome_vfs_address_get_type (void);</programlisting>
190
<indexterm zone="gnome-vfs-address-get-type"><primary>gnome_vfs_address_get_type</primary></indexterm>
191
<programlisting><link linkend="GType">GType</link> gnome_vfs_address_get_type (void);</programlisting>
184
193
</para><variablelist role="params">
185
194
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
187
196
</variablelist></refsect2>
188
197
<refsect2 id="gnome-vfs-address-new-from-ipv4" role="function" condition="since:2.8">
189
198
<title>gnome_vfs_address_new_from_ipv4 ()</title>
190
<indexterm zone="gnome-vfs-address-new-from-ipv4" role="2.8"><primary sortas="gnome_vfs_address_new_from_ipv4">gnome_vfs_address_new_from_ipv4</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_ipv4 (<link linkend="guint32">guint32</link> ipv4_address);</programlisting>
199
<indexterm zone="gnome-vfs-address-new-from-ipv4" role="2.8"><primary>gnome_vfs_address_new_from_ipv4</primary></indexterm>
200
<programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_ipv4 (<link linkend="guint32">guint32</link> ipv4_address);</programlisting>
192
202
Creates a new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link> from <parameter>ipv4_address</parameter>.
199
209
<varlistentry><term><parameter>ipv4_address</parameter> :</term>
200
210
<listitem><simpara> A IPv4 Address in network byte order
201
211
</simpara></listitem></varlistentry>
202
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GnomeVFSAdress"><type>GnomeVFSAdress</type></link>.
212
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GnomeVFSAdress."><type>GnomeVFSAdress.</type></link>
204
214
</simpara></listitem></varlistentry>
205
215
</variablelist><para role="since">Since 2.8</para></refsect2>
206
216
<refsect2 id="gnome-vfs-address-new-from-sockaddr" role="function" condition="since:2.8">
207
217
<title>gnome_vfs_address_new_from_sockaddr ()</title>
208
<indexterm zone="gnome-vfs-address-new-from-sockaddr" role="2.8"><primary sortas="gnome_vfs_address_new_from_sockaddr">gnome_vfs_address_new_from_sockaddr</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_sockaddr (<link linkend="struct-sockaddr">struct sockaddr</link> *sa,
218
<indexterm zone="gnome-vfs-address-new-from-sockaddr" role="2.8"><primary>gnome_vfs_address_new_from_sockaddr</primary></indexterm>
219
<programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_sockaddr (<link linkend="struct-sockaddr">struct sockaddr</link> *sa,
209
220
<link linkend="int">int</link> len);</programlisting>
211
222
Creates a new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link> from <parameter>sa</parameter>.</para>
218
229
<listitem><simpara> The size of <parameter>sa</parameter>.
219
230
</simpara></listitem></varlistentry>
220
231
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>
221
or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>sa</parameter> was invalid or the address family isn't supported.
232
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>sa</parameter> was invalid or the address family isn't supported.
223
234
</simpara></listitem></varlistentry>
224
235
</variablelist><para role="since">Since 2.8</para></refsect2>
225
236
<refsect2 id="gnome-vfs-address-new-from-string" role="function" condition="since:2.8">
226
237
<title>gnome_vfs_address_new_from_string ()</title>
227
<indexterm zone="gnome-vfs-address-new-from-string" role="2.8"><primary sortas="gnome_vfs_address_new_from_string">gnome_vfs_address_new_from_string</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_string (const <link linkend="char">char</link> *address);</programlisting>
238
<indexterm zone="gnome-vfs-address-new-from-string" role="2.8"><primary>gnome_vfs_address_new_from_string</primary></indexterm>
239
<programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> * gnome_vfs_address_new_from_string (const <link linkend="char">char</link> *address);</programlisting>
229
Creates a new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link> from the given string or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
241
Creates a new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link> from the given string or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
230
242
if <parameter>address</parameter> isn't a valid.</para>
232
244
</para><variablelist role="params">
233
245
<varlistentry><term><parameter>address</parameter> :</term>
234
246
<listitem><simpara> A string representation of the address.
235
247
</simpara></listitem></varlistentry>
236
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
248
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
238
250
</simpara></listitem></varlistentry>
239
251
</variablelist><para role="since">Since 2.8</para></refsect2>
240
252
<refsect2 id="gnome-vfs-address-to-string" role="function" condition="since:2.8">
241
253
<title>gnome_vfs_address_to_string ()</title>
242
<indexterm zone="gnome-vfs-address-to-string" role="2.8"><primary sortas="gnome_vfs_address_to_string">gnome_vfs_address_to_string</primary></indexterm><programlisting><link linkend="char">char</link> * gnome_vfs_address_to_string (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
254
<indexterm zone="gnome-vfs-address-to-string" role="2.8"><primary>gnome_vfs_address_to_string</primary></indexterm>
255
<programlisting><link linkend="char">char</link> * gnome_vfs_address_to_string (<link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address);</programlisting>
244
257
Translate <parameter>address</parameter> to a printable string.</para>