glibmm r626 - in trunk: . gio/src
- From: murrayc svn gnome org
- To: svn-commits-list gnome org
- Subject: glibmm r626 - in trunk: . gio/src
- Date: Wed, 27 Feb 2008 16:06:45 +0000 (GMT)
Author: murrayc
Date: Wed Feb 27 16:06:45 2008
New Revision: 626
URL: http://svn.gnome.org/viewvc/glibmm?rev=626&view=rev
Log:
2008-02-27 Murray Cumming <murrayc murrayc com>
* gio/src/gio_docs.xml: Regenerated with docextract_to_xml.py.
* gio/src/gio_docs_override.xml: Override some documentation that
mentions the GCancellable being optional, or that talks about setting
errors instead of throwing them.
Modified:
trunk/ChangeLog
trunk/gio/src/gio_docs.xml
trunk/gio/src/gio_docs_override.xml
Modified: trunk/gio/src/gio_docs.xml
==============================================================================
--- trunk/gio/src/gio_docs.xml (original)
+++ trunk/gio/src/gio_docs.xml Wed Feb 27 16:06:45 2008
@@ -29,7 +29,11 @@
<function name="g_output_stream_flush_async">
<description>
Flushes a stream asynchronously.
+For behaviour details see g_output_stream_flush().
+When the operation is finished @callback will be
+called. You can then call g_output_stream_flush_finish() to get the
+result of the operation.
</description>
<parameters>
@@ -57,6 +61,20 @@
<return></return>
</function>
+<function name="g_input_stream_clear_pending">
+<description>
+Clears the pending flag on @stream.
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> input stream
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_file_attribute_info_list_ref">
<description>
References a file attribute info list.
@@ -144,7 +162,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -245,44 +263,6 @@
</return>
</function>
-<function name="g_mount_remount">
-<description>
-Remounts a mount. This is an asynchronous operation, and is
-finished by calling g_mount_unmount_finish() with the @mount
-and #GAsyncResults data returned in the @callback.
-
-Remounting is useful when some setting affecting the operation
-of the volume has been changed, as these may need a remount to
-take affect. While this is semantically equivalent with unmounting
-and then remounting not all backends might need to actually be
-unmounted.
-
-</description>
-<parameters>
-<parameter name="mount">
-<parameter_description> a #GMount.
-</parameter_description>
-</parameter>
-<parameter name="mount_operation">
-<parameter_description> a #GMountOperation or %NULL to avoid user interaction.
-</parameter_description>
-</parameter>
-<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @callback.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
<function name="g_file_info_get_size">
<description>
Gets the file's size.
@@ -669,7 +649,7 @@
</parameter>
</parameters>
<return> a signed 16-bit/2-byte value read from @stream or %0 if
-an error occured.
+an error occurred.
</return>
</function>
@@ -693,7 +673,8 @@
g_file_parse_name().
This is generally used to show the #GFile as a nice
-string in a user interface, like in a location entry.
+full-pathname kind of string in a user interface,
+like in a location entry.
For local files with names that can safely be converted
to UTF8 the pathname is used, otherwise the IRI is used
@@ -801,7 +782,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -853,7 +834,7 @@
the synchronous version of this call.
When the load operation has completed, @callback will be called
-with @userdata. To finish the operation, call
+with @user data. To finish the operation, call
g_file_load_contents_finish() with the #GAsyncResult returned by
the @callback.
@@ -974,6 +955,31 @@
</return>
</function>
+<function name="g_file_query_filesystem_info_finish">
+<description>
+Finishes an asynchronous filesystem info query. See
+g_file_query_filesystem_info_async().
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="res">
+<parameter_description> a #GAsyncResult.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> #GFileInfo for given @file or %NULL on error.
+</return>
+</function>
+
<function name="g_filename_completer_new">
<description>
Creates a new filename completer.
@@ -1014,6 +1020,47 @@
</return>
</function>
+<function name="g_io_extension_point_lookup">
+<description>
+Looks up an existing extension point.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the name of the extension point
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GIOExtensionPoint, or %NULL if there is no
+registered extension point with the given name
+</return>
+</function>
+
+<function name="g_volume_get_identifier">
+<description>
+Gets the identifier of the given kind for @volume.
+See the &lt;link linkend="volume-identifier"&gt;introduction&lt;/link&gt;
+for more information about volume identifiers.
+
+
+</description>
+<parameters>
+<parameter name="volume">
+<parameter_description> a #GVolume
+</parameter_description>
+</parameter>
+<parameter name="kind">
+<parameter_description> the kind of identifier to return
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the
+requested identfier, or %NULL if the #GVolume
+doesn't have this kind of identifier
+</return>
+</function>
+
<function name="g_file_info_set_content_type">
<description>
Sets the content type attribute for a given #GFileInfo.
@@ -1059,6 +1106,23 @@
</return>
</function>
+<function name="g_io_extension_point_get_required_type">
+<description>
+Gets the required type for @extension_point.
+
+
+</description>
+<parameters>
+<parameter name="extension_point">
+<parameter_description> a #GIOExtensionPoint
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GType that all implementations must have,
+or #G_TYPE_INVALID if the extension point has no required type
+</return>
+</function>
+
<function name="g_loadable_icon_load_async">
<description>
Loads an icon asynchronously. To finish this function, see
@@ -1224,24 +1288,28 @@
</return>
</function>
-<function name="g_file_attribute_info_list_lookup">
+<function name="g_file_find_enclosing_mount_finish">
<description>
-Gets the file attribute with the name @name from @list.
+Finishes an asynchronous find mount request.
+See g_file_find_enclosing_mount_async().
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GFileAttributeInfoList.
+<parameter name="file">
+<parameter_description> a #GFile
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the attribute to lookup.
+<parameter name="res">
+<parameter_description> a #GAsyncResult
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileAttributeInfo for the @name, or %NULL if an
-attribute isn't found.
+<return> #GMount for given @file or %NULL on error.
</return>
</function>
@@ -1279,38 +1347,6 @@
</return>
</function>
-<function name="g_file_output_stream_seek">
-<description>
-Seeks to a location in a file output stream.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileOutputStream.
-</parameter_description>
-</parameter>
-<parameter name="offset">
-<parameter_description> a #goffset to seek.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> a #GSeekType.
-</parameter_description>
-</parameter>
-<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a #GError, %NULL to ignore.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the seek was successful. %FALSE otherwise.
-</return>
-</function>
-
<function name="g_app_info_set_as_default_for_type">
<description>
Sets the application as the default handler for a given type.
@@ -1375,6 +1411,61 @@
</return>
</function>
+<function name="g_file_copy_async">
+<description>
+Copies the file @source to the location specified by @destination
+asynchronously. For details of the behaviour, see g_file_copy().
+
+If @progress_callback is not %NULL, then that function that will be called
+just like in g_file_copy(), however the callback will run in the main loop,
+not in the thread that is doing the I/O operation.
+
+When the operation is finished, @callback will be called. You can then call
+g_file_copy_finish() to get the result of the operation.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="destination">
+<parameter_description> destination #GFile
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> set of #GFileCopyFlags
+</parameter_description>
+</parameter>
+<parameter name="io_priority">
+<parameter_description> the &lt;link linkend="io-priority"&gt;I/O priority&lt;/link&gt;
+of the request.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+<parameter name="progress_callback">
+<parameter_description> function to callback with progress information
+</parameter_description>
+</parameter>
+<parameter name="progress_callback_data">
+<parameter_description> user data to pass to @progress_callback
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the data to pass to callback function
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_cancellable_is_cancelled">
<description>
Checks if a cancellable job has been cancelled.
@@ -1387,30 +1478,27 @@
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @cancellable is is cancelled,
+<return> %TRUE if @cancellable is cancelled,
FALSE if called with %NULL or if item is not cancelled.
</return>
</function>
-<function name="g_file_contains_file">
+<function name="g_drive_enumerate_identifiers">
<description>
-Checks whether @file has the prefix specified by @prefix.
-
-This call does no i/o, as it works purely on names.
+Gets the kinds of identifiers that @drive has.
+Use g_drive_get_identifer() to obtain the identifiers
+themselves.
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> input #GFile.
-</parameter_description>
-</parameter>
-<parameter name="descendant">
-<parameter_description> input #GFile.
+<parameter name="drive">
+<parameter_description> a #GDrive
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @descendent's parent, grandparent, etc is @parent. %FALSE otherwise.
+<return> a %NULL-terminated array of strings containing
+kinds of identifiers. Use g_strfreev() to free.
</return>
</function>
@@ -1418,6 +1506,9 @@
<description>
Gets a list of the volumes on the system.
+The returned list should be freed with g_list_free(), after
+its elements have been unreffed with g_object_unref().
+
</description>
<parameters>
@@ -1426,7 +1517,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GVolume.
+<return> a #GList of #GVolume&lt;!-- --&gt;s.
</return>
</function>
@@ -1612,7 +1703,9 @@
<function name="g_input_stream_close_async">
<description>
Requests an asynchronous closes of the stream, releasing resources related to it.
-When the operation is finished @callback will be called, giving the results.
+When the operation is finished @callback will be called.
+You can then call g_input_stream_close_finish() to get the result of the
+operation.
For behaviour details see g_input_stream_close().
@@ -1649,7 +1742,7 @@
<function name="g_file_input_stream_query_info">
<description>
-Queries a file input stream the given @attributes.his function blocks
+Queries a file input stream the given @attributes. This function blocks
while querying the stream. For the asynchronous (non-blocking) version
of this function, see g_file_input_stream_query_info_async(). While the
stream is blocked, the stream will set the pending flag internally, and
@@ -1726,7 +1819,7 @@
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-Some filesystems don't allow all filenames, and may
+Some file systems don't allow all file names, and may
return an G_IO_ERROR_INVALID_FILENAME error.
If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be
returned. Other errors are possible too, and depend on what kind of
@@ -1824,7 +1917,7 @@
</parameter>
</parameters>
<return> %TRUE if successful. If an error
-has occured, this function will return %FALSE and set @error
+has occurred, this function will return %FALSE and set @error
appropriately if present.
</return>
</function>
@@ -1942,22 +2035,6 @@
</return>
</function>
-<function name="g_file_input_stream_tell">
-<description>
-Gets the current position in the stream.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileInputStream.
-</parameter_description>
-</parameter>
-</parameters>
-<return> a #goffset with the position in the stream.
-</return>
-</function>
-
<function name="g_file_icon_get_file">
<description>
Gets the #GFile associated with the given @icon.
@@ -2016,7 +2093,7 @@
</parameter>
</parameters>
<return> an unsigned 8-bit/1-byte value read from the @stream or %0
-if an error occured.
+if an error occurred.
</return>
</function>
@@ -2024,7 +2101,7 @@
<description>
Launches the application. Passes @files to the launched application
as arguments, using the optional @launch_context to get information
-about the details of the launcher (like what screen its is on).
+about the details of the launcher (like what screen it is on).
On error, @error will be set accordingly.
To lauch the application without arguments pass a %NULL @files list.
@@ -2033,6 +2110,11 @@
can fail to start if it runs into problems during startup. There is
no way to detect this.
+Some URIs can be changed when passed through a GFile (for instance
+unsupported uris with strange formats like mailto:), so if you have
+a textual uri you want to pass in as argument, consider using
+g_app_info_launch_uris() instead.
+
</description>
<parameters>
@@ -2119,7 +2201,7 @@
</parameter>
</parameters>
<return> %TRUE if successful. If an error
-has occured, this function will return %FALSE and set @error
+has occurred, this function will return %FALSE and set @error
appropriately if present.
</return>
</function>
@@ -2140,35 +2222,40 @@
</return>
</function>
-<function name="g_data_input_stream_get_newline_type">
+<function name="g_io_extension_point_get_extension_by_name">
<description>
-Gets the current newline type for the @stream.
+Finds a #GIOExtension for an extension point by name.
</description>
<parameters>
-<parameter name="stream">
-<parameter_description> a given #GDataInputStream.
+<parameter name="extension_point">
+<parameter_description> a #GIOExtensionPoint
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the extension to get
</parameter_description>
</parameter>
</parameters>
-<return> #GDataStreamNewlineType for the given @stream.
+<return> the #GIOExtension for @extension_point that has the
+given name, or %NULL if there is no extension with that name
</return>
</function>
-<function name="g_file_output_stream_can_seek">
+<function name="g_data_input_stream_get_newline_type">
<description>
-Checks if the stream can be seeked.
+Gets the current newline type for the @stream.
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GFileOutputStream.
+<parameter_description> a given #GDataInputStream.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if seeking is supported by the stream.
+<return> #GDataStreamNewlineType for the given @stream.
</return>
</function>
@@ -2213,6 +2300,18 @@
</return>
</function>
+<function name="g_memory_input_stream_new">
+<description>
+Creates a new empty #GMemoryInputStream.
+
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GInputStream
+</return>
+</function>
+
<function name="g_volume_can_eject">
<description>
Checks if a volume can be ejected.
@@ -2319,22 +2418,27 @@
main loop is available, but at that time the I/O job might have
finished. The return value from the callback is ignored.
+Note that if you are passing the @user_data from g_io_scheduler_push_job()
+on to this function you have to ensure that it is not freed before
+ func is called, either by passing %NULL as @notify to
+g_io_scheduler_push_job() or by using refcounting for @user_data.
+
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GIOSchedulerJob.
+<parameter_description> a #GIOSchedulerJob
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> a #GSourceFunc callback that will be called in the main thread.
+<parameter_description> a #GSourceFunc callback that will be called in the main thread
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> a #gpointer.
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
<parameter name="notify">
-<parameter_description> a #GDestroyNotify.
+<parameter_description> a #GDestroyNotify for @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -2485,13 +2589,13 @@
</parameter>
</parameters>
<return> an unsigned 16-bit/2-byte value read from the @stream or %0 if
-an error occured.
+an error occurred.
</return>
</function>
<function name="g_mount_remount_finish">
<description>
-Finishes remounting a mount. If any errors occured during the operation,
+Finishes remounting a mount. If any errors occurred during the operation,
@error will be set to contain the errors and %FALSE will be returned.
@@ -2563,6 +2667,25 @@
</return>
</function>
+<function name="g_io_extension_point_set_required_type">
+<description>
+Sets the required type for @extension_point to @type.
+All implementations must henceforth have this type.
+
+</description>
+<parameters>
+<parameter name="extension_point">
+<parameter_description> a #GIOExtensionPoint
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the #GType to require
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="GVolume">
<description>
This signal is emitted when the #GVolume have been removed. If
@@ -2643,28 +2766,10 @@
</return>
</function>
-<function name="g_local_directory_monitor_new">
-<description>
-
-</description>
-<parameters>
-<parameter name="dirname">
-<parameter_description> filename of the directory to monitor.
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> #GFileMonitorFlags.
-</parameter_description>
-</parameter>
-</parameters>
-<return> new #GFileMonitor for the given @dirname.
-</return>
-</function>
-
<function name="g_file_query_info_async">
<description>
Asynchronously gets the requested information about specified @file. The result
-is a #GFileInfo objects that contains key-value attributes (such as type or size
+is a #GFileInfo object that contains key-value attributes (such as type or size
for the file).
For more details, see g_file_query_info() which is
@@ -2734,8 +2839,14 @@
<function name="g_io_scheduler_push_job">
<description>
-Schedules the I/O Job to run
+Schedules the I/O job to run.
+
+ notify will be called on @user_data after @job_func has returned,
+regardless whether the job was cancelled or has run to completion.
+If @cancellable is not %NULL, it can be used to cancel the I/O job
+by calling g_cancellable_cancel() or by calling
+g_io_scheduler_cancel_all_jobs().
</description>
<parameters>
@@ -2744,11 +2855,11 @@
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> a #gpointer.
+<parameter_description> data to pass to @job_func
</parameter_description>
</parameter>
<parameter name="notify">
-<parameter_description> a #GDestroyNotify.
+<parameter_description> a #GDestroyNotify for @user_data, or %NULL
</parameter_description>
</parameter>
<parameter name="io_priority">
@@ -3150,16 +3261,16 @@
<function name="g_file_query_info">
<description>
Gets the requested information about specified @file. The result
-is a #GFileInfo objects that contains key-value attributes (like type or size
-for the file.
+is a #GFileInfo object that contains key-value attributes (such as
+the type or size of the file).
The @attribute value is a string that specifies the file attributes that
-should be gathered. It is not an error if its not possible to read a particular
-requested attribute from a file, it just won't be set. @attribute should
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
means all attributes, and a wildcard like "standard::*" means all attributes in the standard
namespace. An example attribute query be "standard::*,owner::user".
-The standard attributes are availible as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
@@ -3169,7 +3280,7 @@
symlink is returned, rather than information about the symlink itself.
However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
information about the symlink itself will be returned. Also, for symlinks
-that points to non-existing files the information about the symlink itself
+that point to non-existing files the information about the symlink itself
will be returned.
If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
@@ -3228,6 +3339,9 @@
<description>
Get a list of mountable volumes for @drive.
+The returned list should be freed with g_list_free(), after
+its elements have been unreffed with g_object_unref().
+
</description>
<parameters>
@@ -3284,7 +3398,7 @@
<function name="g_mount_eject_finish">
<description>
-Finishes ejecting a mount. If any errors occured during the operation,
+Finishes ejecting a mount. If any errors occurred during the operation,
@error will be set to contain the errors and %FALSE will be returned.
@@ -3432,6 +3546,33 @@
<return></return>
</function>
+<function name="g_app_info_launch_default_for_uri">
+<description>
+Utility function that launches the default application
+registered to handle the specified uri. Synchronous I/O
+is done on the uri to detext the type of the file if
+required.
+
+
+</description>
+<parameters>
+<parameter name="uri">
+<parameter_description> the uri to show
+</parameter_description>
+</parameter>
+<parameter name="launch_context">
+<parameter_description> an optional #GAppLaunchContext.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE on error.
+</return>
+</function>
+
<function name="g_file_attribute_info_list_dup">
<description>
Makes a duplicate of a file attribute info list.
@@ -3532,17 +3673,47 @@
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GMountOperation.
+<parameter_description> a #GMountOperation
</parameter_description>
</parameter>
-<parameter name="abort">
-<parameter_description> boolean.
+<parameter name="result">
+<parameter_description> a #GMountOperationResult
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="g_themed_icon_new_with_default_fallbacks">
+<description>
+Creates a new themed icon for @iconname, and all the names
+that can be created by shortening @iconname at '-' characters.
+
+In the following example, @icon1 and @icon2 are equivalent:
+|[
+const char *names[] = {
+"gnome-dev-cdrom-audio",
+"gnome-dev-cdrom",
+"gnome-dev",
+"gnome"
+};
+
+icon1 = g_themed_icon_new_from_names (names, 4);
+icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
+]|
+
+
+</description>
+<parameters>
+<parameter name="iconname">
+<parameter_description> a string containing an icon name
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GThemedIcon.
+</return>
+</function>
+
<function name="g_file_make_directory">
<description>
Creates a directory.
@@ -3680,8 +3851,9 @@
<function name="g_output_stream_write_async">
<description>
Request an asynchronous write of @count bytes from @buffer into
-the stream. When the operation is finished @callback will be called,
-giving the results.
+the stream. When the operation is finished @callback will be called.
+You can then call g_output_stream_write_finish() to get the result of the
+operation.
During an async request no other sync and async calls are allowed,
and will result in %G_IO_ERROR_PENDING errors.
@@ -3834,19 +4006,25 @@
</return>
</function>
-<function name="g_file_info_get_display_name">
+<function name="g_drive_get_identifier">
<description>
-Gets a display name for a file.
+Gets the identifier of the given kind for @drive.
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GFileInfo.
+<parameter name="drive">
+<parameter_description> a #GDrive
+</parameter_description>
+</parameter>
+<parameter name="kind">
+<parameter_description> the kind of identifier to return
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the display name.
+<return> a newly allocated string containing the
+requested identfier, or %NULL if the #GDrive
+doesn't have this kind of identifier
</return>
</function>
@@ -3956,6 +4134,31 @@
</return>
</function>
+<function name="g_file_has_prefix">
+<description>
+Checks whether @file has the prefix specified by @prefix. In other word, if the
+names of inital elements of @file&lt;!-- --&gt;s pathname match @prefix.
+
+This call does no i/o, as it works purely on names. As such it can sometimes
+return %FALSE even if @file is inside a @prefix (from a filesystem point of view),
+because the prefix of @file is an alias of @prefix.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="prefix">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @files's parent, grandparent, etc is @prefix. %FALSE otherwise.
+</return>
+</function>
+
<function name="GUnixMountMonitor">
<description>
Emitted when the unix mount points have changed.
@@ -4005,7 +4208,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -4084,7 +4287,10 @@
<function name="g_file_equal">
<description>
-Checks equality of two given #GFile&lt;!-- --&gt;s
+Checks equality of two given #GFile&lt;!-- --&gt;s. Note that two
+#GFile&lt;!-- --&gt;s that differ can still refer to the same
+file on the filesystem due to various forms of filename
+aliasing.
This call does no blocking i/o.
@@ -4252,7 +4458,7 @@
<function name="g_file_get_child">
<description>
-Gets a specific child of @file with name equal to @name.
+Gets a child of @file with basename equal to @name.
Note that the file with that specific name might not exist, but
you can still have a #GFile that points to it. You can use this
@@ -4268,7 +4474,7 @@
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> string containing the child's name.
+<parameter_description> string containing the child's basename.
</parameter_description>
</parameter>
</parameters>
@@ -4305,7 +4511,8 @@
<description>
Requests an asynchronous close of the stream, releasing resources
related to it. When the operation is finished @callback will be
-called, giving the results.
+called. You can then call g_output_stream_close_finish() to get
+the result of the operation.
For behaviour details see g_output_stream_close().
@@ -4529,13 +4736,31 @@
</parameter_description>
</parameter>
<parameter name="include">
-<parameter_description> gio.h
+<parameter_description> gio/gio.h
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="_g_local_directory_monitor_new">
+<description>
+
+</description>
+<parameters>
+<parameter name="dirname">
+<parameter_description> filename of the directory to monitor.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #GFileMonitorFlags.
+</parameter_description>
+</parameter>
+</parameters>
+<return> new #GFileMonitor for the given @dirname.
+</return>
+</function>
+
<function name="GVolumeMonitor">
<description>
Emitted when a drive changes.
@@ -4573,7 +4798,10 @@
<function name="g_io_scheduler_cancel_all_jobs">
<description>
-Cancels all cancellable I/O Jobs.
+Cancels all cancellable I/O jobs.
+
+A job is cancellable if a #GCancellable was passed into
+g_io_scheduler_push_job().
</description>
<parameters>
@@ -4597,7 +4825,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -4612,7 +4840,7 @@
<description>
Sends @file to the "Trashcan", if possible. This is similar to
deleting it, but the user can recover it before emptying the trashcan.
-Not all filesystems support trashing, so this call can return the
+Not all file systems support trashing, so this call can return the
%G_IO_ERROR_NOT_SUPPORTED error.
@@ -4762,7 +4990,7 @@
Asynchronously creates a new file and returns an output stream for writing to it.
The file must not already exists.
-For more details, see g_file_creat() which is
+For more details, see g_file_create() which is
the synchronous version of this call.
When the operation is finished, @callback will be called. You can then call
@@ -4866,7 +5094,7 @@
</parameter>
</parameters>
<return> string with the relative path from @descendant
-to @parent, or %NULL if @descendant is not a descendant of @parent. The returned string should be freed with
+to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with
g_free() when no longer needed.
</return>
</function>
@@ -4987,6 +5215,9 @@
<description>
Gets a list of drives connected to the system.
+The returned list should be freed with g_list_free(), after
+its elements have been unreffed with g_object_unref().
+
</description>
<parameters>
@@ -4995,7 +5226,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of connected #GDrives.
+<return> a #GList of connected #GDrive&lt;!-- --&gt;s
</return>
</function>
@@ -5029,7 +5260,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -5129,7 +5360,7 @@
e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
as it might be on a locally mounted remote filesystem.
-On some systems non-native files may be availible using
+On some systems non-native files may be available using
the native filesystem via a userspace filesystem (FUSE), in
these cases this call will return %FALSE, but g_file_get_path()
will still return a native path.
@@ -5299,7 +5530,12 @@
<function name="g_output_stream_splice_async">
<description>
Splices a stream asynchronously.
+When the operation is finished @callback will be called.
+You can then call g_output_stream_splice_finish() to get the
+result of the operation.
+For the synchronous, blocking version of this function, see
+g_output_stream_splice().
</description>
<parameters>
@@ -5443,6 +5679,25 @@
</return>
</function>
+<function name="g_io_extension_get_name">
+<description>
+Gets the name under which @extension was registered.
+
+Note that the same type may be registered as extension
+for multiple extension points, under different names.
+
+
+</description>
+<parameters>
+<parameter name="extension">
+<parameter_description> a #GIOExtension
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of @extension.
+</return>
+</function>
+
<function name="g_seekable_truncate">
<description>
Truncates a stream with a given #offset.
@@ -5475,7 +5730,7 @@
</parameter>
</parameters>
<return> %TRUE if successful. If an error
-has occured, this function will return %FALSE and set @error
+has occurred, this function will return %FALSE and set @error
appropriately if present.
</return>
</function>
@@ -5743,9 +5998,9 @@
<function name="g_app_info_get_default_for_uri_scheme">
<description>
Gets the default application for launching applications
-using this URI scheme.
-
-TODO: This is currently unimplemented.
+using this URI scheme. A URI scheme is the initial part
+of the URI, up to but not including the ':', e.g. "http",
+"ftp" or "sip".
</description>
@@ -5755,7 +6010,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> %NULL.
+<return> #GAppInfo for given @uri_scheme or %NULL on error.
</return>
</function>
@@ -5833,7 +6088,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -5963,42 +6218,22 @@
</return>
</function>
-<function name="g_file_input_stream_seek">
+<function name="g_themed_icon_append_name">
<description>
-Seeks in the file input stream.
-
-If @cancellable is not %NULL, then the operation can be cancelled by
-triggering the cancellable object from another thread. If the operation
-was cancelled, the error %G_IO_ERROR_CANCELLED will be set.
-
+Append a name to the list of icons from within @icon.
</description>
<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileInputStream.
-</parameter_description>
-</parameter>
-<parameter name="offset">
-<parameter_description> a #goffset to seek.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> a #GSeekType.
-</parameter_description>
-</parameter>
-<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter name="icon">
+<parameter_description> a #GThemedIcon
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a #GError location to store the error occuring, or
-%NULL to ignore.
+<parameter name="iconname">
+<parameter_description> name of icon to append to list of icons from within @icon.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the stream was successfully seeked to the position.
-%FALSE on error.
-</return>
+<return></return>
</function>
<function name="g_file_info_get_attribute_byte_string">
@@ -6071,7 +6306,7 @@
</parameter>
</parameters>
<return> an unsigned 64-bit/8-byte read from @stream or %0 if
-an error occured.
+an error occurred.
</return>
</function>
@@ -6198,6 +6433,22 @@
</return>
</function>
+<function name="g_io_extension_get_type">
+<description>
+Gets the type associated with @extension.
+
+
+</description>
+<parameters>
+<parameter name="extension">
+<parameter_description> a #GIOExtension
+</parameter_description>
+</parameter>
+</parameters>
+<return> the type of @extension
+</return>
+</function>
+
<function name="g_cancellable_get_current">
<description>
Gets the top cancellable from the stack.
@@ -6230,7 +6481,7 @@
If @progress_callback is not %NULL, then the operation can be monitored by
setting this to a #GFileProgressCallback function. @progress_callback_data
will be passed to this function. It is guaranteed that this callback will
-be called after all data has been transfered with the total number of bytes
+be called after all data has been transferred with the total number of bytes
copied during the operation.
If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
@@ -6274,7 +6525,7 @@
</parameter_description>
</parameter>
<parameter name="progress_callback_data">
-<parameter_description> userdata to pass to @progress_callback
+<parameter_description> user data to pass to @progress_callback
</parameter_description>
</parameter>
<parameter name="error">
@@ -6411,7 +6662,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GFileInfo&lt;!----&gt;s.
+<return> a #GList of #GFileInfo&lt;!----&gt;s. You must free the list with g_list_free
+and unref the infos with g_object_unref when your done with them.
</return>
</function>
@@ -6464,6 +6716,9 @@
<description>
Gets a list of the mounts on the system.
+The returned list should be freed with g_list_free(), after
+its elements have been unreffed with g_object_unref().
+
</description>
<parameters>
@@ -6472,7 +6727,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GMount.
+<return> a #GList of #GMount&lt;!-- --&gt;s
</return>
</function>
@@ -6682,22 +6937,6 @@
</return>
</function>
-<function name="g_file_input_stream_can_seek">
-<description>
-Checks if a file input stream can be seeked.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileInputStream.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if stream can be seeked. %FALSE otherwise.
-</return>
-</function>
-
<function name="g_file_info_get_attribute_string">
<description>
Gets the value of a string attribute. If the attribute does
@@ -6856,7 +7095,7 @@
If there is an error during the operation %FALSE is returned and @error
is set to indicate the error status, @bytes_read is updated to contain
-the number of bytes read into @buffer before the error occured.
+the number of bytes read into @buffer before the error occurred.
</description>
@@ -7000,7 +7239,7 @@
<function name="g_file_replace_async">
<description>
-Asyncronously overwrites the file, replacing the contents, possibly
+Asynchronously overwrites the file, replacing the contents, possibly
creating a backup copy of the file first.
For more details, see g_file_replace() which is
@@ -7135,7 +7374,7 @@
</parameter>
</parameters>
<return> a signed 64-bit/8-byte value read from @stream or %0 if
-an error occured.
+an error occurred.
</return>
</function>
@@ -7199,22 +7438,6 @@
</return>
</function>
-<function name="g_file_output_stream_tell">
-<description>
-Gets the current location within the stream.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileOutputStream.
-</parameter_description>
-</parameter>
-</parameters>
-<return> a #goffset of the location within the stream.
-</return>
-</function>
-
<function name="g_file_resolve_relative_path">
<description>
Resolves a relative path for @file to an absolute path.
@@ -7315,7 +7538,7 @@
</parameter>
</parameters>
<return> a signed 32-bit/4-byte value read from the @stream or %0 if
-an error occured.
+an error occurred.
</return>
</function>
@@ -7381,6 +7604,10 @@
<parameter_description> input #GFile.
</parameter_description>
</parameter>
+<parameter name="flags">
+<parameter_description> flags affecting the operation
+</parameter_description>
+</parameter>
<parameter name="mount_operation">
<parameter_description> a #GMountOperation or %NULL to avoid user interaction.
</parameter_description>
@@ -7390,7 +7617,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -7527,9 +7754,50 @@
</return>
</function>
+<function name="g_file_set_attribute_string">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
+If @attribute is of a different type, this operation will fail.
+
+If @cancellable is not %NULL, then the operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a string containing the attribute's value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set, %FALSE otherwise.
+</return>
+</function>
+
<function name="g_io_modules_load_all_in_directory">
<description>
-Loads all the modules in the the specified directory.
+Loads all the modules in the specified directory.
</description>
@@ -7547,6 +7815,24 @@
</return>
</function>
+<function name="g_io_extension_point_get_extensions">
+<description>
+Gets a list of all extensions that implement this extension point.
+The list is sorted by priority, beginning with the highest priority.
+
+
+</description>
+<parameters>
+<parameter name="extension_point">
+<parameter_description> a #GIOExtensionPoint
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GList of #GIOExtension&lt;!-- --&gt;s. The list is owned by
+GIO and should not be modified
+</return>
+</function>
+
<function name="g_volume_mount">
<description>
Mounts a volume.
@@ -7557,6 +7843,10 @@
<parameter_description> a #GVolume.
</parameter_description>
</parameter>
+<parameter name="flags">
+<parameter_description> flags affecting the operation
+</parameter_description>
+</parameter>
<parameter name="mount_operation">
<parameter_description> a #GMountOperation or %NULL to avoid user interaction.
</parameter_description>
@@ -7566,7 +7856,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -7577,6 +7867,38 @@
<return></return>
</function>
+<function name="g_io_extension_point_implement">
+<description>
+Registers @type as extension for the extension point with name
+ extension_point_name
+
+If @type has already been registered as an extension for this
+extension point, the existing #GIOExtension object is returned.
+
+
+</description>
+<parameters>
+<parameter name="extension_point_name">
+<parameter_description> the name of the extension point
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the #GType to register as extension
+</parameter_description>
+</parameter>
+<parameter name="extension_name">
+<parameter_description> the name for the extension
+</parameter_description>
+</parameter>
+<parameter name="priority">
+<parameter_description> the priority for the extension
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GIOExtension object for #GType
+</return>
+</function>
+
<function name="g_unix_mount_is_readonly">
<description>
Checks if a unix mount is mounted read only.
@@ -7638,11 +7960,32 @@
</return>
</function>
+<function name="g_file_attribute_info_list_lookup">
+<description>
+Gets the file attribute with the name @name from @list.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GFileAttributeInfoList.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the attribute to lookup.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileAttributeInfo for the @name, or %NULL if an
+attribute isn't found.
+</return>
+</function>
+
<function name="g_app_info_get_id">
<description>
Gets the ID of an application. An id is a string that
identifies the application. The exact format of the id is
-platform dependent. For instance on Unix this is the
+platform dependent. For instance, on Unix this is the
desktop file id from the xdg menu specification.
Note that the returned ID may be %NULL, depending on how
@@ -7685,10 +8028,9 @@
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-If a file with this name already exists the G_IO_ERROR_EXISTS error
-will be returned. If the file is a directory the G_IO_ERROR_IS_DIRECTORY
+If a file or directory with this name already exists the G_IO_ERROR_EXISTS
error will be returned.
-Some filesystems don't allow all filenames, and may
+Some file systems don't allow all file names, and may
return an G_IO_ERROR_INVALID_FILENAME error, and if the name
is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
Other errors are possible too, and depend on what kind of
@@ -7719,6 +8061,32 @@
</return>
</function>
+<function name="g_memory_input_stream_add_data">
+<description>
+Appends @data to data that can be read from the input stream
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GMemoryInputStream
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> input data
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of the data, may be -1 if @data is a nul-terminated string
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> function that is called to free @data, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_content_type_get_description">
<description>
Gets the human readable description of the content type.
@@ -7817,8 +8185,8 @@
stream.
Streams will be automatically closed when the last reference
-is dropped, but you might want to call make sure resources
-are released as early as possible.
+is dropped, but you might want to call this function to make sure
+resources are released as early as possible.
Some streams might keep the backing store of the stream (e.g. a file descriptor)
open after the stream is closed. See the documentation for the individual
@@ -7904,7 +8272,8 @@
</parameter>
<parameter name="new_etag">
<parameter_description> a location to a new &lt;link linkend="gfile-etag"&gt;entity tag&lt;/link&gt;
-for the document.
+for the document. This should be freed with g_free() when no longer
+needed.
</parameter_description>
</parameter>
<parameter name="cancellable">
@@ -7917,7 +8286,7 @@
</parameter>
</parameters>
<return> %TRUE if successful. If an error
-has occured, this function will return %FALSE and set @error
+has occurred, this function will return %FALSE and set @error
appropriately if present.
</return>
</function>
@@ -7946,7 +8315,7 @@
<description>
Launches the application. Passes @uris to the launched application
as arguments, using the optional @launch_context to get information
-about the details of the launcher (like what screen its is on).
+about the details of the launcher (like what screen it is on).
On error, @error will be set accordingly.
To lauch the application without arguments pass a %NULL @uris list.
@@ -8159,14 +8528,37 @@
</return>
</function>
-<function name="g_input_stream_clear_pending">
+<function name="g_file_find_enclosing_mount_async">
<description>
-Clears the pending flag on @stream.
+Asynchronously gets the mount for the file.
+
+For more details, see g_file_find_enclosing_mount() which is
+the synchronous version of this call.
+
+When the operation is finished, @callback will be called. You can then call
+g_file_find_enclosing_mount_finish() to get the result of the operation.
</description>
<parameters>
-<parameter name="stream">
-<parameter_description> input stream
+<parameter name="file">
+<parameter_description> a #GFile
+</parameter_description>
+</parameter>
+<parameter name="io_priority">
+<parameter_description> the &lt;link linkend="io-priority"&gt;I/O priority&lt;/link&gt;
+of the request.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the data to pass to callback function
</parameter_description>
</parameter>
</parameters>
@@ -8318,7 +8710,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -8329,6 +8721,30 @@
<return></return>
</function>
+<function name="g_file_query_default_handler">
+<description>
+Returns: a #GAppInfo if the handle was found, %NULL if there were errors.
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> a #GFile to open.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GAppInfo if the handle was found, %NULL if there were errors.
+When you are done with it, release it with g_object_unref()
+</return>
+</function>
+
<function name="g_app_info_supports_files">
<description>
Checks if the application accepts files as arguments.
@@ -8393,13 +8809,34 @@
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return></return>
+</function>
+
+<function name="g_io_extension_get_priority">
+<description>
+Gets the priority with which @extension was registered.
+
+
+</description>
+<parameters>
+<parameter name="extension">
+<parameter_description> a #GIOExtension
+</parameter_description>
+</parameter>
+</parameters>
+<return> the priority of @extension
+</return>
</function>
<function name="g_file_input_stream_query_info_async">
<description>
-Queries the stream information asynchronously. For the synchronous
-version of this function, see g_file_input_stream_query_info().
+Queries the stream information asynchronously.
+When the operation is finished @callback will be called.
+You can then call g_file_input_stream_query_info_finish()
+to get the result of the operation.
+
+For the synchronous version of this function,
+see g_file_input_stream_query_info().
If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
@@ -8751,12 +9188,12 @@
all the files in the directory.
The @attribute value is a string that specifies the file attributes that
-should be gathered. It is not an error if its not possible to read a particular
-requested attribute from a file, it just won't be set. @attribute should
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
means all attributes, and a wildcard like "standard::*" means all attributes in the standard
namespace. An example attribute query be "standard::*,owner::user".
-The standard attributes are availible as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
@@ -8867,19 +9304,19 @@
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GIOSchedulerJob.
+<parameter_description> a #GIOSchedulerJob
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> a #GSourceFunc callback that will be called in the main thread.
+<parameter_description> a #GSourceFunc callback that will be called in the main thread
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> a #gpointer.
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
<parameter name="notify">
-<parameter_description> a #GDestroyNotify.
+<parameter_description> a #GDestroyNotify for @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -8931,35 +9368,7 @@
</parameter>
</parameters>
<return> an unsigned 32-bit/4-byte value read from the @stream or %0 if
-an error occured.
-</return>
-</function>
-
-<function name="g_file_output_stream_truncate">
-<description>
-Truncates a file output stream.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileOutputStream.
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> a #goffset to truncate the stream at.
-</parameter_description>
-</parameter>
-<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a #GError, %NULL to ignore.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if @stream is truncated successfully.
+an error occurred.
</return>
</function>
@@ -9032,6 +9441,8 @@
has taken place. Should be called from file monitor
implementations only.
+The signal will be emitted from an idle handler.
+
</description>
<parameters>
<parameter name="monitor">
@@ -9054,6 +9465,31 @@
<return></return>
</function>
+<function name="g_file_copy_finish">
+<description>
+Finishes copying the file started with
+g_file_copy_async().
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="res">
+<parameter_description> a #GAsyncResult.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a %TRUE on success, %FALSE on error.
+</return>
+</function>
+
<function name="g_mount_get_name">
<description>
Gets the name of @mount.
@@ -9202,12 +9638,18 @@
<function name="g_file_get_basename">
<description>
-Gets the basename (the last component of the path) for a given #GFile.
+Gets the base name (the last component of the path) for a given #GFile.
-If called for the toplevel of a system (such as the filesystem root
-or a uri like sftp://host/ it will return a single directory separator
+If called for the top level of a system (such as the filesystem root
+or a uri like sftp://host/) it will return a single directory separator
(and on Windows, possibly a drive letter).
+The base name is a byte string (*not* UTF-8). It has no defined encoding
+or rules other than it may not contain zero bytes. If you want to use
+filenames in a user interface you should use the display name that you
+can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
+attribute with g_file_query_info().
+
This call does no blocking i/o.
@@ -9240,6 +9682,33 @@
</return>
</function>
+<function name="g_desktop_app_info_lookup_get_default_for_uri_scheme">
+<description>
+Gets the default application for launching applications
+using this URI scheme for a particular GDesktopAppInfoLookup
+implementation.
+
+The GDesktopAppInfoLookup interface and this function is used
+to implement g_app_info_get_default_for_uri_scheme() backends
+in a GIO module. There is no reason for applications to use it
+directly. Applications should use g_app_info_get_default_for_uri_scheme().
+
+
+</description>
+<parameters>
+<parameter name="lookup">
+<parameter_description> a #GDesktopAppInfoLookup
+</parameter_description>
+</parameter>
+<parameter name="uri_scheme">
+<parameter_description> a string containing a URI scheme.
+</parameter_description>
+</parameter>
+</parameters>
+<return> #GAppInfo for given @uri_scheme or %NULL on error.
+</return>
+</function>
+
<function name="g_file_info_set_attribute_int32">
<description>
Sets the @attribute to contain the given @attr_value,
@@ -9324,8 +9793,8 @@
Closing a stream multiple times will not return an error.
Streams will be automatically closed when the last reference
-is dropped, but you might want to call make sure resources
-are released as early as possible.
+is dropped, but you might want to call this function to make sure
+resources are released as early as possible.
Some streams might keep the backing store of the stream (e.g. a file descriptor)
open after the stream is closed. See the documentation for the individual
@@ -9381,6 +9850,10 @@
<parameter_description> input #GFile.
</parameter_description>
</parameter>
+<parameter name="flags">
+<parameter_description> flags affecting the operation
+</parameter_description>
+</parameter>
<parameter name="mount_operation">
<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
</parameter_description>
@@ -9390,7 +9863,7 @@
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -9444,8 +9917,8 @@
enumerator return %G_IO_ERROR_CLOSED on all calls.
This will be automatically called when the last reference
-is dropped, but you might want to call make sure resources
-are released as early as possible.
+is dropped, but you might want to call this function to make
+sure resources are released as early as possible.
</description>
@@ -9487,6 +9960,21 @@
</return>
</function>
+<function name="g_volume_should_automount">
+<description>
+Returns: %TRUE if the volume should be automatically mounted.
+
+</description>
+<parameters>
+<parameter name="volume">
+<parameter_description> a #GVolume
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the volume should be automatically mounted.
+</return>
+</function>
+
<function name="g_memory_output_stream_get_data">
<description>
Gets any loaded data from the @ostream.
@@ -9551,7 +10039,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #gssize containig the size of the data spliced.
+<return> a #gssize containing the size of the data spliced.
</return>
</function>
@@ -9578,6 +10066,25 @@
<return></return>
</function>
+<function name="g_volume_enumerate_identifiers">
+<description>
+Gets the kinds of &lt;link linkend="volume-identifier"&gt;identifiers&lt;/link&gt;
+that @volume has. Use g_volume_get_identifer() to obtain
+the identifiers themselves.
+
+
+</description>
+<parameters>
+<parameter name="volume">
+<parameter_description> a #GVolume
+</parameter_description>
+</parameter>
+</parameters>
+<return> a %NULL-terminated array of strings containing
+kinds of identifiers. Use g_strfreev() to free.
+</return>
+</function>
+
<function name="g_unix_mount_points_get">
<description>
Gets a #GList of strings containing the unix mount points.
@@ -9615,8 +10122,9 @@
<function name="g_input_stream_skip_async">
<description>
Request an asynchronous skip of @count bytes from the stream into the buffer
-starting at @buffer. When the operation is finished @callback will be called,
-giving the results.
+starting at @buffer. When the operation is finished @callback will be called.
+You can then call g_input_stream_skip_finish() to get the result of the
+operation.
During an async request no other sync and async calls are allowed, and will
result in %G_IO_ERROR_PENDING errors.
@@ -9724,6 +10232,64 @@
</return>
</function>
+<function name="g_file_query_exists">
+<description>
+Utility function to check if a particular file exists. This is
+implemented using g_file_query_info() and as such does blocking I/O.
+
+Note that in many cases it is racy to first check for file existance
+and then execute something based on the outcome of that, because the
+file might have been created or removed inbetween the operations. The
+general approach to handling that is to not check, but just do the
+operation and handle the errors as they come.
+
+As an example of race-free checking, take the case of reading a file, and
+if it doesn't exist, creating it. There are two racy versions: read it, and
+on error create it; and: check if it exists, if not create it. These
+can both result in two processes creating the file (with perhaps a partially
+written file as the result). The correct approach is to always try to create
+the file with g_file_create() which will either atomically create the file
+or fail with a G_IO_ERROR_EXISTS error.
+
+However, in many cases an existance check is useful in a user
+interface, for instance to make a menu item sensitive/insensitive, so that
+you don't have to fool users that something is possible and then just show
+and error dialog. If you do this, you should make sure to also handle the
+errors that can happen due to races when you execute the operation.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
+</return>
+</function>
+
+<function name="g_io_extension_ref_class">
+<description>
+Gets a reference to the class for the type that is
+associated with @extension.
+
+
+</description>
+<parameters>
+<parameter name="extension">
+<parameter_description> a #GIOExtension
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GTypeClass for the type of @extension
+</return>
+</function>
+
<function name="g_app_info_get_default_for_type">
<description>
Gets the #GAppInfo that correspond to a given content type.
@@ -9741,7 +10307,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> #GAppInfo for given @content_type.
+<return> #GAppInfo for given @content_type or %NULL on error.
</return>
</function>
@@ -9749,18 +10315,18 @@
<description>
Similar to g_file_query_info(), but obtains information
about the filesystem the @file is on, rather than the file itself.
-For instance the amount of space availible and the type of
+For instance the amount of space available and the type of
the filesystem.
The @attribute value is a string that specifies the file attributes that
-should be gathered. It is not an error if its not possible to read a particular
-requested attribute from a file, it just won't be set. @attribute should
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
means all attributes, and a wildcard like "fs:*" means all attributes in the fs
namespace. The standard namespace for filesystem attributes is "fs".
Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
(the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
-bytes availible), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
+bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
If @cancellable is not %NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
@@ -9793,45 +10359,46 @@
</return>
</function>
-<function name="g_file_set_attribute_string">
+<function name="g_mount_remount">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
-If @attribute is of a different type, this operation will fail.
-
-If @cancellable is not %NULL, then the operation can be cancelled by
-triggering the cancellable object from another thread. If the operation
-was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+Remounts a mount. This is an asynchronous operation, and is
+finished by calling g_mount_remount_finish() with the @mount
+and #GAsyncResults data returned in the @callback.
+Remounting is useful when some setting affecting the operation
+of the volume has been changed, as these may need a remount to
+take affect. While this is semantically equivalent with unmounting
+and then remounting not all backends might need to actually be
+unmounted.
</description>
<parameters>
-<parameter name="file">
-<parameter_description> input #GFile.
-</parameter_description>
-</parameter>
-<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<parameter name="mount">
+<parameter_description> a #GMount.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a string containing the attribute's value.
+<parameter name="flags">
+<parameter_description> flags affecting the operation
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> #GFileQueryInfoFlags.
+<parameter name="mount_operation">
+<parameter_description> a #GMountOperation or %NULL to avoid user interaction.
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter name="callback">
+<parameter_description> a #GAsyncReadyCallback, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @callback.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @attribute was successfully set, %FALSE otherwise.
-</return>
+<return></return>
</function>
<function name="g_file_read_finish">
@@ -9949,7 +10516,7 @@
On success, the number of bytes written to the stream is returned.
It is not an error if this is not the same as the requested size, as it
-can happen e.g. on a partial i/o error, or if the there is not enough
+can happen e.g. on a partial i/o error, or if there is not enough
storage in the stream. All writes either block until at least one byte
is written, so zero is never returned (unless @count is zero).
@@ -10002,7 +10569,7 @@
If there is an error during the operation FALSE is returned and @error
is set to indicate the error status, @bytes_written is updated to contain
-the number of bytes written into the stream before the error occured.
+the number of bytes written into the stream before the error occurred.
</description>
@@ -10077,6 +10644,10 @@
<parameter_description> optional #GCancellable object, %NULL to ignore.
</parameter_description>
</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL.
+</parameter_description>
+</parameter>
</parameters>
<return> a #GFileMonitor for the given @file.
</return>
@@ -10084,9 +10655,9 @@
<function name="g_file_output_stream_get_etag">
<description>
-Gets the entity tag for the file when its been written.
+Gets the entity tag for the file when it has been written.
This must be called after the stream has been written
-and closed. As the etag can change while writing.
+and closed, as the etag can change while writing.
</description>
@@ -10104,7 +10675,7 @@
<description>
Tries to move the file or directory @source to the location specified by @destination.
-If native move operations is supported then this is used, otherwise a copy + delete
+If native move operations are supported then this is used, otherwise a copy + delete
fallback is used. The native implementation may support moving directories (for instance
on moves inside the same filesystem), but the fallback code does not.
@@ -10122,7 +10693,7 @@
If @progress_callback is not %NULL, then the operation can be monitored by
setting this to a #GFileProgressCallback function. @progress_callback_data
will be passed to this function. It is guaranteed that this callback will
-be called after all data has been transfered with the total number of bytes
+be called after all data has been transferred with the total number of bytes
copied during the operation.
If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
@@ -10137,7 +10708,7 @@
If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
-may be returned (if the native move operation isn't availible).
+may be returned (if the native move operation isn't available).
</description>
@@ -10496,6 +11067,23 @@
</return>
</function>
+<function name="g_io_extension_point_register">
+<description>
+Registers an extension point.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> The name of the extension point
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GIOExtensionPoint. This object is owned by GIO
+and should not be freed
+</return>
+</function>
+
<function name="g_simple_async_result_new_from_error">
<description>
Creates a #GSimpleAsyncResult from an error condition.
@@ -10527,8 +11115,9 @@
<function name="g_input_stream_read_async">
<description>
Request an asynchronous read of @count bytes from the stream into the buffer
-starting at @buffer. When the operation is finished @callback will be called,
-giving the results.
+starting at @buffer. When the operation is finished @callback will be called.
+You can then call g_input_stream_read_finish() to get the result of the
+operation.
During an async request no other sync and async calls are allowed, and will
result in %G_IO_ERROR_PENDING errors.
@@ -10617,22 +11206,6 @@
</return>
</function>
-<function name="g_file_output_stream_can_truncate">
-<description>
-Checks if the stream can be truncated.
-
-
-</description>
-<parameters>
-<parameter name="stream">
-<parameter_description> a #GFileOutputStream.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if stream can be truncated.
-</return>
-</function>
-
<function name="g_file_load_contents_finish">
<description>
Finishes an asynchronous load of the @file's contents.
@@ -10717,7 +11290,8 @@
</parameter>
<parameter name="new_etag">
<parameter_description> a location of a new &lt;link linkend="gfile-etag"&gt;entity tag&lt;/link&gt;
-for the document.
+for the document. This should be freed with g_free() when it is no
+longer needed.
</parameter_description>
</parameter>
<parameter name="error">
@@ -10804,6 +11378,22 @@
</return>
</function>
+<function name="g_file_info_get_display_name">
+<description>
+Gets a display name for a file.
+
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GFileInfo.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a string containing the display name.
+</return>
+</function>
+
<function name="_g_unix_volume_monitor_lookup_volume_for_mount_path">
<description>
@@ -10846,6 +11436,10 @@
<parameter_description> optional #GCancellable object, %NULL to ignore.
</parameter_description>
</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL.
+</parameter_description>
+</parameter>
</parameters>
<return> a #GFileMonitor for the given @file,
or %NULL on error.
@@ -10967,7 +11561,7 @@
<function name="g_mount_unmount_finish">
<description>
-Finishes unmounting a mount. If any errors occured during the operation,
+Finishes unmounting a mount. If any errors occurred during the operation,
@error will be set to contain the errors and %FALSE will be returned.
@@ -11211,7 +11805,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> #GList of #GAppInfo s for given @content_type.
+<return> #GList of #GAppInfo s for given @content_type
+or %NULL on error.
</return>
</function>
@@ -11401,4 +11996,49 @@
</return>
</function>
+<function name="g_file_query_filesystem_info_async">
+<description>
+Asynchronously gets the requested information about the filesystem
+that the specified @file is on. The result is a #GFileInfo object
+that contains key-value attributes (such as type or size for the
+file).
+
+For more details, see g_file_query_filesystem_info() which is the
+synchronous version of this call.
+
+When the operation is finished, @callback will be called. You can
+then call g_file_query_info_finish() to get the result of the
+operation.
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attributes">
+<parameter_description> an attribute query string.
+</parameter_description>
+</parameter>
+<parameter name="io_priority">
+<parameter_description> the &lt;link linkend="io-priority"&gt;I/O priority&lt;/link&gt;
+of the request.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the data to pass to callback function
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
</root>
Modified: trunk/gio/src/gio_docs_override.xml
==============================================================================
--- trunk/gio/src/gio_docs_override.xml (original)
+++ trunk/gio/src/gio_docs_override.xml Wed Feb 27 16:06:45 2008
@@ -1,2 +1,1696 @@
<root>
+<function name="g_file_make_symbolic_link">
+<description>
+Creates a symbolic link.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="symlink_value">
+<parameter_description> a string with the value of the new symlink.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on the creation of a new symlink, %FALSE otherwise.
+</return>
+</function>
+
+
+<function name="g_file_enumerator_close_finish">
+<description>
+Finishes closing a file enumerator, started from g_file_enumerator_close_async().
+
+If the file enumerator was already closed when g_file_enumerator_close_async()
+was called, then this function will throw a Gio::Error with CLOSED, and
+return %FALSE. If the file enumerator had pending operation when the close
+operation was started, then this function will throw a Gio::Error with PENDING, and
+return %FALSE. The operation may have been
+cancelled by triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error with CANCELLED will be thrown, and %FALSE will be
+returned.
+
+
+</description>
+<parameters>
+<parameter name="enumerator">
+<parameter_description> a #GFileEnumerator.
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> a #GAsyncResult.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError location to store the error occuring, or %NULL to
+ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the close operation has finished successfully.
+</return>
+</function>
+
+<function name="g_file_append_to">
+<description>
+Gets an output stream for appending data to the file. If
+the file doesn't already exist it is created.
+
+By default files created are generally readable by everyone,
+but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
+will be made readable only to the current user, to the level that
+is supported on the target filesystem.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+Some file systems don't allow all file names, and may
+throw a Gio::Error with INVALID_FILENAME.
+If the file is a directory a Gio::Error with IS_DIRECTORY will be
+thrown. Other errors are possible too, and depend on what kind of
+filesystem the file is on.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileCreateFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileOutputStream.
+</return>
+</function>
+
+
+<function name="g_file_set_attribute_int32">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
+If @attribute is of a different type, this operation will fail.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #gint32 containing the attribute's new value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set to @value
+in the @file, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_delete">
+<description>
+Deletes a file.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the file was deleted. %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_seekable_seek">
+<description>
+Seeks in the stream by the given @offset, modified by @type.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="seekable">
+<parameter_description> a #GSeekable.
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> a #goffset.
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> a #GSeekType.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError location to store the error occuring, or %NULL to
+ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if successful. If an error
+has occurred, this function will return %FALSE and set @error
+appropriately if present.
+</return>
+</function>
+
+<function name="g_file_set_display_name">
+<description>
+Renames @file to the specified display name.
+
+The display name is converted from UTF8 to the correct encoding for the target
+filesystem if possible and the @file is renamed to this.
+
+If you want to implement a rename operation in the user interface the edit name
+(#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
+widget, and then the result after editing should be passed to g_file_set_display_name().
+
+On success the resulting converted filename is returned.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="display_name">
+<parameter_description> a string.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFile specifying what @file was renamed to, or %NULL if there was an error.
+</return>
+</function>
+
+<function name="g_file_set_attribute_byte_string">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
+If @attribute is of a different type, this operation will fail,
+returning %FALSE.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a string containing the attribute's new value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set to @value
+in the @file, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_query_info">
+<description>
+Gets the requested information about specified @file. The result
+is a #GFileInfo object that contains key-value attributes (such as
+the type or size of the file).
+
+The @attribute value is a string that specifies the file attributes that
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
+be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
+means all attributes, and a wildcard like "standard::*" means all attributes in the standard
+namespace. An example attribute query be "standard::*,owner::user".
+The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+For symlinks, normally the information about the target of the
+symlink is returned, rather than information about the symlink itself.
+However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
+information about the symlink itself will be returned. Also, for symlinks
+that point to non-existing files the information about the symlink itself
+will be returned.
+
+If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
+Other errors are possible too, and depend on what kind of filesystem the file is on.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attributes">
+<parameter_description> an attribute query string.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileInfo for the given @file, or %NULL on error.
+</return>
+</function>
+
+<function name="g_input_stream_skip">
+<description>
+Tries to skip @count bytes from the stream. Will block during the operation.
+
+This is identical to g_input_stream_read(), from a behaviour standpoint,
+but the bytes that are skipped are not returned to the user. Some
+streams have an implementation that is more efficient than reading the data.
+
+This function is optional for inherited classes, as the default implementation
+emulates it using read.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GInputStream.
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> the number of bytes that will be skipped from the stream
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> Number of bytes skipped, or -1 on error
+</return>
+</function>
+
+<function name="g_file_make_directory">
+<description>
+Creates a directory.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on successful creation, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_set_attribute_uint32">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
+If @attribute is of a different type, this operation will fail.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #guint32 containing the attribute's new value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set to @value
+in the @file, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_query_writable_namespaces">
+<description>
+Obtain the list of attribute namespaces where new attributes
+can be created by a user. An example of this is extended
+attributes (in the "xattr" namespace).
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileAttributeInfoList describing the writable namespaces.
+When you are done with it, release it with g_file_attribute_info_list_unref()
+</return>
+</function>
+
+<function name="g_file_trash">
+<description>
+Sends @file to the "Trashcan", if possible. This is similar to
+deleting it, but the user can recover it before emptying the trashcan.
+Not all file systems support trashing, so this call can throw a Gio::Error with
+ NOT_SUPPORTED.
+
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> #GFile to send to trash.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on successful trash, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_set_attributes_from_info">
+<description>
+Tries to set all attributes in the #GFileInfo on the target values,
+not stopping on the first error.
+
+If there is any error during this operation then @error will be set to
+the first error. Error on particular fields are flagged by setting
+the "status" field in the attribute value to
+%G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
+further errors.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> a #GFileInfo.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #GFileQueryInfoFlags
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if there was any error, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_set_attribute_uint64">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
+If @attribute is of a different type, this operation will fail.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #guint64 containing the attribute's new value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set to @value
+in the @file, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_output_stream_flush">
+<description>
+Flushed any outstanding buffers in the stream. Will block during
+the operation. Closing the stream will implicitly cause a flush.
+
+This function is optional for inherited classes.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GOutputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE on error
+</return>
+</function>
+
+
+<function name="g_seekable_truncate">
+<description>
+Truncates a stream with a given #offset.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+
+</description>
+<parameters>
+<parameter name="seekable">
+<parameter_description> a #GSeekable.
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> a #goffset.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError location to store the error occuring, or %NULL to
+ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if successful. If an error
+has occurred, this function will return %FALSE and set @error
+appropriately if present.
+</return>
+</function>
+
+<function name="g_buffered_input_stream_read_byte">
+<description>
+Tries to read a single byte from the stream or the buffer. Will block
+during this read.
+
+On success, the byte read from the stream is returned. On end of stream
+-1 is returned but it's not an exceptional error and @error is not set.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> #GBufferedInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the byte read from the @stream, or -1 on end of stream or error.
+</return>
+</function>
+
+
+<function name="g_data_input_stream_read_uint64">
+<description>
+Reads an unsigned 64-bit/8-byte value from @stream.
+
+In order to get the correct byte order for this read operation,
+see g_data_stream_get_byte_order().
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a given #GDataInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> an unsigned 64-bit/8-byte read from @stream or %0 if
+an error occurred.
+</return>
+</function>
+
+<function name="g_file_output_stream_query_info">
+<description>
+Queries a file output stream for the given @attributes.
+This function blocks while querying the stream. For the asynchronous
+version of this function, see g_file_output_stream_query_info_async().
+While the stream is blocked, the stream will set the pending flag
+internally, and any other operations on the stream will fail with
+PENDING.
+
+Can fail if the stream was already closed (throwing a Gio::Error with
+CLOSED), the stream has pending operations (throwing a Gio::Error with
+PENDING), or if querying info is not supported for
+the stream's interface (throwing a Gio::Error with NOT_SUPPORTED). In
+all cases of failure, %NULL will be returned.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED, and %NULL will
+be returned.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GFileOutputStream.
+</parameter_description>
+</parameter>
+<parameter name="attributes">
+<parameter_description> a file attribute query string.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, %NULL to ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileInfo for the @stream, or %NULL on error.
+</return>
+</function>
+
+
+<function name="g_file_set_attribute_int64">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
+If @attribute is of a different type, this operation will fail.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #guint64 containing the attribute's new value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_find_enclosing_mount">
+<description>
+Gets a #GMount for the #GFile.
+
+If the #GFileIface for @file does not have a mount (e.g. possibly a
+remote share), a Gio::Error will be thrown with NOT_FOUND and %NULL
+will be returned.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GMount where the @file is located or %NULL on error.
+</return>
+</function>
+
+<function name="g_data_input_stream_read_int64">
+<description>
+Reads a 64-bit/8-byte value from @stream.
+
+In order to get the correct byte order for this read operation,
+see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a given #GDataInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a signed 64-bit/8-byte value read from @stream or %0 if
+an error occurred.
+</return>
+</function>
+
+<function name="g_buffered_input_stream_fill">
+<description>
+Tries to read @count bytes from the stream into the buffer.
+Will block during this read.
+
+If @count is zero, returns zero and does nothing. A value of @count
+larger than %G_MAXSSIZE will cause a Gio::Error to be thrown, with INVALID_ARGUMENT.
+
+On success, the number of bytes read into the buffer is returned.
+It is not an error if this is not the same as the requested size, as it
+can happen e.g. near the end of a file. Zero is returned on end of file
+(or if @count is zero), but never otherwise.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+
+
+For the asynchronous, non-blocking, version of this function, see
+g_buffered_input_stream_fill_async().
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> #GBufferedInputStream.
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> the number of bytes that will be read from the stream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of bytes read into @stream's buffer, up to @count,
+or -1 on error.
+</return>
+</function>
+
+<function name="g_data_input_stream_read_int32">
+<description>
+Reads a signed 32-bit/4-byte value from @stream.
+
+In order to get the correct byte order for this read operation,
+see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a given #GDataInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a signed 32-bit/4-byte value read from the @stream or %0 if
+an error occurred.
+</return>
+</function>
+
+
+<function name="g_file_set_attribute_string">
+<description>
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
+If @attribute is of a different type, this operation will fail.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a string containing the attribute's value.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @attribute was successfully set, %FALSE otherwise.
+</return>
+</function>
+
+
+<function name="g_file_create">
+<description>
+Creates a new file and returns an output stream for writing to it.
+The file must not already exists.
+
+By default files created are generally readable by everyone,
+but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
+will be made readable only to the current user, to the level that
+is supported on the target filesystem.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+If a file or directory with this name already exists a Gio::Error with EXISTS
+will be thrown.
+Some file systems don't allow all file names, and may
+throw a Gio::Error with INVALID_FILENAME, and if the name
+is to long a Gio::Error with FILENAME_TOO_LONG will be thrown.
+Other errors are possible too, and depend on what kind of
+filesystem the file is on.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileCreateFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileOutputStream for the newly created file, or
+%NULL on error.
+</return>
+</function>
+
+<function name="g_file_load_contents">
+<description>
+Loads the content of the file into memory, returning the size of
+the data. The data is always zero terminated, but this is not
+included in the resultant @length.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="contents">
+<parameter_description> a location to place the contents of the file.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> a location to place the length of the contents of the file.
+</parameter_description>
+</parameter>
+<parameter name="etag_out">
+<parameter_description> a location to place the current entity tag for the file.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the @file's contents were successfully loaded.
+%FALSE if there were errors..
+</return>
+</function>
+
+<function name="g_output_stream_close">
+<description>
+Closes the stream, releasing resources related to it.
+
+Once the stream is closed, all other operations will throw a Gio::Error with
+CLOSED. Closing a stream multiple times will not cause an error to be
+thrown.
+
+Closing a stream will automatically flush any outstanding buffers in the
+stream.
+
+Streams will be automatically closed when the last reference
+is dropped, but you might want to call this function to make sure
+resources are released as early as possible.
+
+Some streams might keep the backing store of the stream (e.g. a file descriptor)
+open after the stream is closed. See the documentation for the individual
+stream for details.
+
+On failure the first error that happened will be reported, but the close
+operation will finish as much as possible. A stream that failed to
+close will still throw a Gio::Error with CLOSED for all operations. Still, it
+is important to check and report the error to the user, otherwise
+there might be a loss of data as all data might not be written.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+Cancelling a close will still leave the stream closed, but there some streams
+can use a faster close that doesn't block to e.g. check errors. On
+cancellation (as with any error) there is no guarantee that all written
+data will reach the target.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> A #GOutputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE on failure
+</return>
+</function>
+
+<function name="g_file_replace_contents">
+<description>
+Replaces the contents of @file with @contents of @length bytes.
+
+If @etag is specified any existing file must have that etag, or
+a Gio::Errrow with WRONG_ETAG will be thrown.
+
+If @make_backup is %TRUE, this function will attempt to make a backup of @file.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+The returned @new_etag can be used to verify that the file hasn't changed the
+next time it is saved over.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="contents">
+<parameter_description> a string containing the new contents for @file.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the length of @contents in bytes.
+</parameter_description>
+</parameter>
+<parameter name="etag">
+<parameter_description> the old &lt;link linkend="gfile-etag"&gt;entity tag&lt;/link&gt;
+for the document.
+</parameter_description>
+</parameter>
+<parameter name="make_backup">
+<parameter_description> %TRUE if a backup should be created.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileCreateFlags.
+</parameter_description>
+</parameter>
+<parameter name="new_etag">
+<parameter_description> a location to a new &lt;link linkend="gfile-etag"&gt;entity tag&lt;/link&gt;
+for the document. This should be freed with g_free() when no longer
+needed.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if successful. If an error
+has occurred, this function will return %FALSE and set @error
+appropriately if present.
+
+
+</return>
+</function>
+
+<function name="g_data_input_stream_read_line">
+<description>
+Reads a line from the data input stream.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a given #GDataInputStream.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> a #gsize to get the length of the data read in.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a string with the line that was read in (including the newlines).
+Set @length to a #gsize to get the length of the read line. Returns %NULL on an error.
+</return>
+</function>
+
+
+<function name="g_input_stream_read">
+<description>
+Tries to read @count bytes from the stream into the buffer starting at
+ buffer Will block during this read.
+
+If count is zero returns zero and does nothing. A value of @count
+larger than %G_MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
+
+On success, the number of bytes read into the buffer is returned.
+It is not an error if this is not the same as the requested size, as it
+can happen e.g. near the end of a file. Zero is returned on end of file
+(or if @count is zero), but never otherwise.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GInputStream.
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> a buffer to read data into (which should be at least count bytes long).
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> the number of bytes that will be read from the stream
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> Number of bytes read, or -1 on error
+</return>
+</function>
+
+<function name="g_file_enumerate_children">
+<description>
+Gets the requested information about the files in a directory. The result
+is a #GFileEnumerator object that will give out #GFileInfo objects for
+all the files in the directory.
+
+The @attribute value is a string that specifies the file attributes that
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
+be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
+means all attributes, and a wildcard like "standard::*" means all attributes in the standard
+namespace. An example attribute query be "standard::*,owner::user".
+The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
+If the file is not a directory, a Gio::Error with FILE_ERROR_NOTDIR will be returned.
+Other errors are possible too.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attributes">
+<parameter_description> an attribute query string.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #GFileEnumerator if successful, %NULL on error.
+</return>
+</function>
+
+<function name="g_data_input_stream_read_uint32">
+<description>
+Reads an unsigned 32-bit/4-byte value from @stream.
+
+In order to get the correct byte order for this read operation,
+see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a given #GDataInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting.
+</parameter_description>
+</parameter>
+</parameters>
+<return> an unsigned 32-bit/4-byte value read from the @stream or %0 if
+an error occurred.
+</return>
+</function>
+
+<function name="g_input_stream_close">
+<description>
+Closes the stream, releasing resources related to it.
+
+Once the stream is closed, all other operations will throw a Gio::Error with CLOSED.
+Closing a stream multiple times will not return an error.
+
+Streams will be automatically closed when the last reference
+is dropped, but you might want to call this function to make sure
+resources are released as early as possible.
+
+Some streams might keep the backing store of the stream (e.g. a file descriptor)
+open after the stream is closed. See the documentation for the individual
+stream for details.
+
+On failure the first error that happened will be reported, but the close
+operation will finish as much as possible. A stream that failed to
+close will still throw a Gio::Error with CLOSED for all operations. Still, it
+is important to check and report the error to the user.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+Cancelling a close will still leave the stream closed, but some streams
+can use a faster close that doesn't block to e.g. check errors.
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> A #GInputStream.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE on failure
+</return>
+</function>
+
+
+<function name="g_file_query_filesystem_info">
+<description>
+Similar to g_file_query_info(), but obtains information
+about the filesystem the @file is on, rather than the file itself.
+For instance the amount of space available and the type of
+the filesystem.
+
+The @attribute value is a string that specifies the file attributes that
+should be gathered. It is not an error if it's not possible to read a particular
+requested attribute from a file - it just won't be set. @attribute should
+be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
+means all attributes, and a wildcard like "fs:*" means all attributes in the fs
+namespace. The standard namespace for filesystem attributes is "fs".
+Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
+(the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
+bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
+Other errors are possible too, and depend on what kind of filesystem the file is on.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attributes">
+<parameter_description> an attribute query string.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileInfo or %NULL if there was an error.
+</return>
+</function>
+
+<function name="g_output_stream_write">
+<description>
+Tries to write @count bytes from @buffer into the stream. Will block
+during the operation.
+
+If count is zero returns zero and does nothing. A value of @count
+larger than %G_MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
+
+On success, the number of bytes written to the stream is returned.
+It is not an error if this is not the same as the requested size, as it
+can happen e.g. on a partial i/o error, or if there is not enough
+storage in the stream. All writes either block until at least one byte
+is written, so zero is never returned (unless @count is zero).
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED. If an
+operation was partially finished when the operation was cancelled the
+partial result will be returned, without an error.
+
+
+
+
+</description>
+<parameters>
+<parameter name="stream">
+<parameter_description> a #GOutputStream.
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> the buffer containing the data to write.
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> the number of bytes to write
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+</parameter_description>
+</parameter>
+</parameters>
+<return> Number of bytes written, or -1 on error
+</return>
+</function>
+
+<function name="g_file_monitor_file">
+<description>
+Obtains a file monitor for the given file. If no file notification
+mechanism exists, then regular polling of the file is used.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileMonitorFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileMonitor for the given @file.
+</return>
+</function>
+
+<function name="g_file_set_attribute">
+<description>
+Sets an attribute in the file with attribute name @attribute to @value.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> a string containing the attribute's name.
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> The type of the attribute
+</parameter_description>
+</parameter>
+<parameter name="value_p">
+<parameter_description> a pointer to the value (or the pointer itself if the type is a pointer type)
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileQueryInfoFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the attribute was set, %FALSE otherwise.
+</return>
+</function>
+
+<function name="g_file_read">
+<description>
+Opens a file for reading. The result is a #GFileInputStream that
+can be used to read the contents of the file.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
+If the file is a directory, a Gio::Error with IS_DIRECTORY will be thrown.
+Other errors are possible too, and depend on what kind of filesystem the file is on.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> #GFile to read.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> a #GCancellable
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> #GFileInputStream or %NULL on error.
+</return>
+</function>
+
+<function name="g_file_monitor_directory">
+<description>
+Obtains a directory monitor for the given file.
+This may fail if directory monitoring is not supported.
+
+The operation can be cancelled by
+triggering the cancellable object from another thread. If the operation
+was cancelled, a Gio::Error will be thrown with CANCELLED.
+
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a set of #GFileMonitorFlags.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> Cancellable object.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError, or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GFileMonitor for the given @file,
+or %NULL on error.
+</return>
+</function>
+
+
</root>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
