<return></return>
</signal>
+<signal name="GMountOperation::show-unmount-progress">
+<description>
+Emitted when an unmount operation has been busy for more than some time
+(typically 1.5 seconds).
+
+When unmounting or ejecting a volume, the kernel might need to flush
+pending data in its buffers to the volume stable storage, and this operation
+can take a considerable amount of time. This signal may be emitted several
+times as long as the unmount operation is outstanding, and then one
+last time when the operation is completed, with @bytes_left set to zero.
+
+Implementations of GMountOperation should handle this signal by
+showing an UI notification, and then dismiss it, or show another notification
+of completion, when @bytes_left reaches zero.
+
+If the message contains a line break, the first line should be
+presented as a heading. For example, it may be used as the
+primary text in a #GtkMessageDialog.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="op">
+<parameter_description> a #GMountOperation:
+</parameter_description>
+</parameter>
+<parameter name="message">
+<parameter_description> string containing a mesage to display to the user
+</parameter_description>
+</parameter>
+<parameter name="time_left">
+<parameter_description> the estimated time left before the operation completes,
+in microseconds, or -1
+</parameter_description>
+</parameter>
+<parameter name="bytes_left">
+<parameter_description> the amount of bytes to be written before the operation
+completes (or -1 if such amount is not known), or zero if the operation
+is completed
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<signal name="GNetworkMonitor::network-changed">
<description>
Emitted when the network configuration changes. If @available is
</return>
</function>
+<function name="foo_igen_naming_get_type_">
+<description>
+Gets the value of the <link linkend="gdbus-property-Naming.Type">"Type"</link> D-Bus property.
+
+Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.
+
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> A #FooiGenNaming.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The property value.
+</return>
+</function>
+
+<function name="foo_igen_naming_interface_info">
+<description>
+Gets a machine-readable description of the <link linkend="gdbus-interface-Naming.top_of_page">Naming</link> D-Bus interface.
+
+
+</description>
+<parameters>
+</parameters>
+<return> A #GDBusInterfaceInfo. Do not free.
+</return>
+</function>
+
+<function name="foo_igen_naming_override_properties">
+<description>
+Overrides all #GObject properties in the #FooiGenNaming interface for a concrete class.
+The properties are overridden in the order they are defined.
+
+
+</description>
+<parameters>
+<parameter name="klass">
+<parameter_description> The class structure for a #GObject<!-- -->-derived class.
+</parameter_description>
+</parameter>
+<parameter name="property_id_begin">
+<parameter_description> The property id to assign to the first overridden property.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The last property id.
+</return>
+</function>
+
+<function name="foo_igen_naming_proxy_new">
+<description>
+Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-Naming.top_of_page">Naming</link>. See g_dbus_proxy_new() for more details.
+
+When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
+You can then call foo_igen_naming_proxy_new_finish() to get the result of the operation.
+
+See foo_igen_naming_proxy_new_sync() for the synchronous, blocking version of this constructor.
+
+</description>
+<parameters>
+<parameter name="connection">
+<parameter_description> A #GDBusConnection.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Flags from the #GDBusProxyFlags enumeration.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
+</parameter_description>
+</parameter>
+<parameter name="object_path">
+<parameter_description> An object path.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> A #GCancellable or %NULL.
+</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> User data to pass to @callback.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="foo_igen_naming_proxy_new_finish">
+<description>
+Finishes an operation started with foo_igen_naming_proxy_new().
+
+
+</description>
+<parameters>
+<parameter name="res">
+<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_naming_proxy_new().
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for error or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The constructed proxy object or %NULL if @error is set.
+</return>
+</function>
+
+<function name="foo_igen_naming_proxy_new_for_bus">
+<description>
+Like foo_igen_naming_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
+
+When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
+You can then call foo_igen_naming_proxy_new_for_bus_finish() to get the result of the operation.
+
+See foo_igen_naming_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.
+
+</description>
+<parameters>
+<parameter name="bus_type">
+<parameter_description> A #GBusType.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Flags from the #GDBusProxyFlags enumeration.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> A bus name (well-known or unique).
+</parameter_description>
+</parameter>
+<parameter name="object_path">
+<parameter_description> An object path.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> A #GCancellable or %NULL.
+</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> User data to pass to @callback.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="foo_igen_naming_proxy_new_for_bus_finish">
+<description>
+Finishes an operation started with foo_igen_naming_proxy_new_for_bus().
+
+
+</description>
+<parameters>
+<parameter name="res">
+<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_naming_proxy_new_for_bus().
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for error or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The constructed proxy object or %NULL if @error is set.
+</return>
+</function>
+
+<function name="foo_igen_naming_proxy_new_for_bus_sync">
+<description>
+Like foo_igen_naming_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
+
+The calling thread is blocked until a reply is received.
+
+See foo_igen_naming_proxy_new_for_bus() for the asynchronous version of this constructor.
+
+
+</description>
+<parameters>
+<parameter name="bus_type">
+<parameter_description> A #GBusType.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Flags from the #GDBusProxyFlags enumeration.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> A bus name (well-known or unique).
+</parameter_description>
+</parameter>
+<parameter name="object_path">
+<parameter_description> An object path.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> A #GCancellable or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for error or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The constructed proxy object or %NULL if @error is set.
+</return>
+</function>
+
+<function name="foo_igen_naming_proxy_new_sync">
+<description>
+Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-Naming.top_of_page">Naming</link>. See g_dbus_proxy_new_sync() for more details.
+
+The calling thread is blocked until a reply is received.
+
+See foo_igen_naming_proxy_new() for the asynchronous version of this constructor.
+
+
+</description>
+<parameters>
+<parameter name="connection">
+<parameter_description> A #GDBusConnection.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Flags from the #GDBusProxyFlags enumeration.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
+</parameter_description>
+</parameter>
+<parameter name="object_path">
+<parameter_description> An object path.
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> A #GCancellable or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for error or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The constructed proxy object or %NULL if @error is set.
+</return>
+</function>
+
+<function name="foo_igen_naming_set_type_">
+<description>
+Sets the <link linkend="gdbus-property-Naming.Type">"Type"</link> D-Bus property to @value.
+
+Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> A #FooiGenNaming.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The value to set.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="foo_igen_naming_skeleton_new">
+<description>
+Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-Naming.top_of_page">Naming</link>.
+
+
+</description>
+<parameters>
+</parameters>
+<return> The skeleton object.
+</return>
+</function>
+
<function name="foo_igen_object_get_authorize">
<description>
Gets the #FooiGenAuthorize instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link> on @object, if any.
</return>
</function>
+<function name="foo_igen_object_get_naming">
+<description>
+Gets the #FooiGenNaming instance for the D-Bus interface <link linkend="gdbus-interface-Naming.top_of_page">Naming</link> on @object, if any.
+
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> A #FooiGenObject.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #FooiGenNaming that must be freed with g_object_unref() or %NULL if @object does not implement the interface.
+</return>
+</function>
+
<function name="foo_igen_object_get_oldie_interface">
<description>
Gets the #FooiGenOldieInterface instance for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link> on @object, if any.
</return>
</function>
+<function name="foo_igen_object_peek_naming">
+<description>
+Like foo_igen_object_get_naming() but doesn't increase the reference count on the returned object.
+
+<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning>
+
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> A #FooiGenObject.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #FooiGenNaming or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.
+</return>
+</function>
+
<function name="foo_igen_object_peek_oldie_interface">
<description>
Like foo_igen_object_get_oldie_interface() but doesn't increase the reference count on the returned object.
<return></return>
</function>
+<function name="foo_igen_object_skeleton_set_naming">
+<description>
+Sets the #FooiGenNaming instance for the D-Bus interface <link linkend="gdbus-interface-Naming.top_of_page">Naming</link> on @object.
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> A #FooiGenObjectSkeleton.
+</parameter_description>
+</parameter>
+<parameter name="interface_">
+<parameter_description> A #FooiGenNaming or %NULL to clear the interface.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="foo_igen_object_skeleton_set_oldie_interface">
<description>
Sets the #FooiGenOldieInterface instance for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link> on @object.
</description>
<parameters>
-<parameter name="info">
+<parameter name="appinfo">
<parameter_description> a #GAppInfo that can handle files
</parameter_description>
</parameter>
</return>
</function>
+<function name="g_async_result_is_tagged">
+<description>
+Checks if @result has the given @source_tag (generally a function
+pointer indicating the function @result was created by).
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="result">
+<parameter_description> a #GAsyncResult
+</parameter_description>
+</parameter>
+<parameter name="source_tag">
+<parameter_description> an application-defined tag
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @result has the indicated @source_tag, %FALSE if
+not.
+
+</return>
+</function>
+
+<function name="g_async_result_legacy_propagate_error">
+<description>
+If @result is a #GSimpleAsyncResult, this is equivalent to
+g_simple_async_result_propagate_error(). Otherwise it returns
+%FALSE.
+
+This can be used for legacy error handling in async
+<literal>_finish ()</literal> wrapper functions that traditionally
+handled #GSimpleAsyncResult error returns themselves rather than
+calling into the virtual method. This should not be used in new
+code; #GAsyncResult errors that are set by virtual methods should
+also be extracted by virtual methods, to enable subclasses to chain
+up correctly.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="result">
+<parameter_description> a #GAsyncResult
+</parameter_description>
+</parameter>
+<parameter name="dest">
+<parameter_description> a location to propagate the error to.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @error is has been filled in with an error from
+@res, %FALSE if not.
+
+</return>
+</function>
+
<function name="g_buffered_input_stream_fill">
<description>
Tries to read @count bytes from the stream into the buffer.
</return>
</function>
+<function name="g_content_type_get_symbolic_icon">
+<description>
+Gets the symbolic icon for a content type.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="type">
+<parameter_description> a content type string
+</parameter_description>
+</parameter>
+</parameters>
+<return> symbolic #GIcon corresponding to the content type.
+Free the returned object with g_object_unref()
+
+</return>
+</function>
+
<function name="g_content_type_guess">
<description>
Guesses the content type based on example data. If the function is
<description>
Parses @xml_data and returns a #GDBusNodeInfo representing the data.
+The introspection XML must contain exactly one top-level
+<tag class="starttag">node</tag> element.
+
Note that this routine is using a
<link linkend="glib-Simple-XML-Subset-Parser.description">GMarkup</link>-based
parser that only accepts a subset of valid XML documents.
</return>
</function>
+<function name="g_dbus_object_manager_server_is_exported">
+<description>
+Returns whether @object is currently exported on @manager.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> A #GDBusObjectManagerServer.
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> An object.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @object is exported
+
+</return>
+</function>
+
<function name="g_dbus_object_manager_server_new">
<description>
Creates a new #GDBusObjectManagerServer object.
</return>
</function>
+<function name="g_drive_get_symbolic_icon">
+<description>
+Gets the icon for @drive.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="drive">
+<parameter_description> a #GDrive.
+</parameter_description>
+</parameter>
+</parameters>
+<return> symbolic #GIcon for the @drive.
+Free the returned object with g_object_unref().
+
+</return>
+</function>
+
<function name="g_drive_get_volumes">
<description>
Get a list of mountable volumes for @drive.
<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.
+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.
-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.
+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.
-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
-filesystem the file is on.
+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 filesystem the file is on.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
For more details, see g_file_append_to() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_append_to_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_append_to_finish() to get the result
+of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_append_to_finish">
<description>
-Finishes an asynchronous file append operation started with
-g_file_append_to_async().
+Finishes an asynchronous file append operation started with
+g_file_append_to_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
</parameter_description>
</parameter>
</parameters>
-<return> a valid #GFileOutputStream or %NULL on error.
+<return> a valid #GFileOutputStream
+or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-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 transferred with the total number of bytes
-copied during the operation.
+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 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
-error is returned, independent on the status of the @destination.
+If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
+is returned, independent on the status of the @destination.
-If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
-error G_IO_ERROR_EXISTS is returned.
+If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
+the error %G_IO_ERROR_EXISTS is returned.
-If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
+If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
error is returned. If trying to overwrite a directory with a directory the
-G_IO_ERROR_WOULD_MERGE error is returned.
+%G_IO_ERROR_WOULD_MERGE error is returned.
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 is returned.
+%G_IO_ERROR_WOULD_RECURSE error is returned.
If you are interested in copying the #GFile object itself (not the on-disk
file), see g_file_dup().
</description>
<parameters>
<parameter name="source">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="destination">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="progress_callback">
</description>
<parameters>
<parameter name="source">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="destination">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="progress_callback">
<function name="g_file_copy_attributes">
<description>
-Copies the file attributes from @source to @destination.
+Copies the file attributes from @source to @destination.
Normally only a subset of the file attributes are copied,
those that are copies in a normal file copy operation
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GFile with attributes.
+<parameter_description> a #GFile with attributes
</parameter_description>
</parameter>
<parameter name="destination">
-<parameter_description> a #GFile to copy attributes to.
+<parameter_description> a #GFile to copy attributes to
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCopyFlags.
+<parameter_description> a set of #GFileCopyFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, %NULL to ignore.
+<parameter_description> a #GError, %NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the attributes were copied successfully, %FALSE otherwise.
+<return> %TRUE if the attributes were copied successfully,
+%FALSE otherwise.
</return>
</function>
<function name="g_file_copy_finish">
<description>
-Finishes copying the file started with
-g_file_copy_async().
+Finishes copying the file started with g_file_copy_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
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.
+will be made readable only to the current user, to the level
+that is supported on the target filesystem.
-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.
+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.
-If a file or directory with this name already exists the G_IO_ERROR_EXISTS
-error will be returned.
-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
-filesystem the file is on.
+If a file or directory with this name already exists the
+%G_IO_ERROR_EXISTS error will be returned. 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 filesystem the file is on.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileOutputStream for the newly created file, or
-%NULL on error.
+<return> a #GFileOutputStream for the newly created
+file, or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_create_async">
<description>
-Asynchronously creates a new file and returns an output stream for writing to it.
-The file must not already exist.
+Asynchronously creates a new file and returns an output stream
+for writing to it. The file must not already exist.
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
-g_file_create_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_create_finish() to get the result
+of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_create_finish">
<description>
-Finishes an asynchronous file create operation started with
-g_file_create_async().
+Finishes an asynchronous file create operation started with
+g_file_create_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_create_readwrite">
<description>
-Creates a new file and returns a stream for reading and writing to it.
-The file must not already exist.
+Creates a new file and returns a stream for reading and
+writing to it. The file must not already exist.
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.
+will be made readable only to the current user, to the level
+that is supported on the target filesystem.
-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.
+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.
-If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
-error will be returned. Some file systems don't allow all file names,
-and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
-is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
-are possible too, and depend on what kind of filesystem the file is on.
+If a file or directory with this name already exists, the
+%G_IO_ERROR_EXISTS error will be returned. Some file systems don't
+allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
+error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
+will be returned. Other errors are possible too, and depend on what
+kind of filesystem the file is on.
-Note that in many non-local file cases read and write streams are not
-supported, so make sure you really need to do read and write streaming,
-rather than just opening for reading or writing.
+Note that in many non-local file cases read and write streams are
+not supported, so make sure you really need to do read and write
+streaming, rather than just opening for reading or writing.
Since: 2.22
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileIOStream for the newly created file, or %NULL on error.
+<return> a #GFileIOStream for the newly created
+file, or %NULL on error.
Free the returned object with g_object_unref().
</return>
<function name="g_file_create_readwrite_async">
<description>
-Asynchronously creates a new file and returns a stream for reading and
-writing to it. The file must not already exist.
+Asynchronously creates a new file and returns a stream
+for reading and writing to it. The file must not already exist.
For more details, see g_file_create_readwrite() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then
-call g_file_create_readwrite_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_create_readwrite_finish() to get
+the result of the operation.
Since: 2.22
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_delete">
<description>
-Deletes a file. If the @file is a directory, it will only be deleted if it
-is empty.
+Deletes a file. If the @file is a directory, it will only be
+deleted if it is empty. This has the same semantics as g_unlink().
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Virtual: delete_file
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
</return>
</function>
+<function name="g_file_delete_async">
+<description>
+Asynchronously delete a file. If the @file is a directory, it will
+only be deleted if it is empty. This has the same semantics as
+g_unlink().
+
+Virtual: delete_file_async
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> input #GFile
+</parameter_description>
+</parameter>
+<parameter name="io_priority">
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+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>
+
+<function name="g_file_delete_finish">
+<description>
+Finishes deleting a file started with g_file_delete_async().
+
+Virtual: delete_file_finish
+Since: 2.34
+
+</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></return>
+</function>
+
<function name="g_file_descriptor_based_get_fd">
<description>
Gets the underlying file descriptor.
<function name="g_file_dup">
<description>
-Duplicates a #GFile handle. This operation does not duplicate
-the actual file or directory represented by the #GFile; see
-g_file_copy() if attempting to copy a file.
+Duplicates a #GFile handle. This operation does not duplicate
+the actual file or directory represented by the #GFile; see
+g_file_copy() if attempting to copy a file.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> a new #GFile that is a duplicate of the given #GFile.
+<return> a new #GFile that is a duplicate
+of the given #GFile.
</return>
</function>
<function name="g_file_eject_mountable">
<description>
-Starts an asynchronous eject on a mountable.
+Starts an asynchronous eject on a mountable.
When this operation has completed, @callback will be called with
-@user_user data, and the operation can be finalized with
+@user_user data, and the operation can be finalized with
g_file_eject_mountable_finish().
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_eject_mountable_finish">
<description>
-Finishes an asynchronous eject operation started by
+Finishes an asynchronous eject operation started by
g_file_eject_mountable().
-Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
+Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
+instead.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @file was ejected successfully. %FALSE
-otherwise.
+<return> %TRUE if the @file was ejected successfully.
+%FALSE otherwise.
</return>
</function>
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="mount_operation">
-<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
+<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> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @file was ejected successfully. %FALSE
-otherwise.
+<return> %TRUE if the @file was ejected successfully.
+%FALSE otherwise.
</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 @attributes 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. @attributes should
-be a comma-separated list of attributes 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.
-
-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.
+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 @attributes 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. @attributes should
+be a comma-separated list of attributes 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.
+
+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.
-If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
-If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
-Other errors are possible too.
+If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
+be returned. If the file is not a directory, the %G_FILE_ERROR_NOTDIR
+error will be returned. Other errors are possible too.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileQueryInfoFlags.
+<parameter_description> a set of #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> #GError for error reporting.
+<parameter_description> #GError for error reporting
</parameter_description>
</parameter>
</parameters>
-<return> A #GFileEnumerator if successful, %NULL on error.
-Free the returned object with g_object_unref().
+<return> A #GFileEnumerator if successful,
+%NULL on error. Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_enumerate_children_async">
<description>
-Asynchronously 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.
+Asynchronously 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.
For more details, see g_file_enumerate_children() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_enumerate_children_finish() to get the result of the operation.
+When the operation is finished, @callback will be called. You can
+then call g_file_enumerate_children_finish() to get the result of
+the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileQueryInfoFlags.
+<parameter_description> a set of #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileEnumerator or %NULL if an error occurred.
+<return> a #GFileEnumerator or %NULL
+if an error occurred.
Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_equal">
<description>
-Checks equality of two given #GFile<!-- -->s. Note that two
-#GFile<!-- -->s that differ can still refer to the same
+Checks equality of two given #GFiles.
+
+Note that two #GFiles 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.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file1">
-<parameter_description> the first #GFile.
+<parameter_description> the first #GFile
</parameter_description>
</parameter>
<parameter name="file2">
-<parameter_description> the second #GFile.
+<parameter_description> the second #GFile
</parameter_description>
</parameter>
</parameters>
<function name="g_file_find_enclosing_mount">
<description>
-Gets a #GMount for the #GFile.
+Gets a #GMount for the #GFile.
-If the #GFileIface for @file does not have a mount (e.g. possibly a
-remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
-will be returned.
+If the #GFileIface for @file does not have a mount (e.g.
+possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
+and %NULL will be returned.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> a #GMount where the @file is located or %NULL on error.
+<return> a #GMount where the @file is located
+or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
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.
+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_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_find_enclosing_mount_finish">
<description>
-Finishes an asynchronous find mount request.
+Finishes an asynchronous find mount request.
See g_file_find_enclosing_mount_async().
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
+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.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> string containing the #GFile's base name, or %NULL
-if given #GFile is invalid. The returned string should be
+<return> string containing the #GFile's base name, or %NULL
+if given #GFile is invalid. The returned string should be
freed with g_free() when no longer needed.
</return>
</function>
you can still have a #GFile that points to it. You can use this
for instance to create that file.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> string containing the child's basename.
+<parameter_description> string containing the child's basename
</parameter_description>
</parameter>
</parameters>
<function name="g_file_get_child_for_display_name">
<description>
-Gets the child of @file for a given @display_name (i.e. a UTF8
-version of the name). If this function fails, it returns %NULL and @error will be
-set. This is very useful when constructing a GFile for a new file
-and the user entered the filename in the user interface, for instance
-when you select a directory and type a filename in the file selector.
+Gets the child of @file for a given @display_name (i.e. a UTF-8
+version of the name). If this function fails, it returns %NULL
+and @error will be set. This is very useful when constructing a
+#GFile for a new file and the user entered the filename in the
+user interface, for instance when you select a directory and
+type a filename in the file selector.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="display_name">
-<parameter_description> string to a possible child.
+<parameter_description> string to a possible child
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> #GError.
+<parameter_description> return location for an error
</parameter_description>
</parameter>
</parameters>
-<return> a #GFile to the specified child, or
-%NULL if the display name couldn't be converted.
+<return> a #GFile to the specified child, or
+%NULL if the display name couldn't be converted.
Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_get_parent">
<description>
-Gets the parent directory for the @file.
-If the @file represents the root directory of the
+Gets the parent directory for the @file.
+If the @file represents the root directory of the
file system, then %NULL will be returned.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> a #GFile structure to the parent of the given
-#GFile or %NULL if there is no parent.
-Free the returned object with g_object_unref().
+<return> a #GFile structure to the
+parent of the given #GFile or %NULL if there is
+no parent. Free the returned object with g_object_unref().
</return>
</function>
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
-(a form of URI that allows UTF8 characters unescaped).
+to UTF-8 the pathname is used, otherwise the IRI is used
+(a form of URI that allows UTF-8 characters unescaped).
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the #GFile's parse name. The returned
-string should be freed with g_free() when no longer needed.
+<return> a string containing the #GFile's parse name.
+The returned string should be freed with g_free()
+when no longer needed.
</return>
</function>
<function name="g_file_get_path">
<description>
-Gets the local pathname for #GFile, if one exists.
+Gets the local pathname for #GFile, if one exists.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> string containing the #GFile's path, or %NULL if
-no such path exists. The returned string should be
+<return> string containing the #GFile's path, or %NULL if
+no such path exists. The returned string should be
freed with g_free() when no longer needed.
</return>
</function>
<function name="g_file_get_relative_path">
<description>
-Gets the path for @descendant relative to @parent.
+Gets the path for @descendant relative to @parent.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="parent">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="descendant">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> string with the relative path from @descendant
-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> string with the relative path from @descendant
+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>
<description>
Gets the URI for the @file.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
<return> a string containing the #GFile's URI.
-The returned string should be freed with g_free() when no longer needed.
+The returned string should be freed with g_free()
+when no longer needed.
</return>
</function>
Gets the URI scheme for a #GFile.
RFC 3986 decodes the scheme as:
<programlisting>
-URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
+URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
</programlisting>
-Common schemes include "file", "http", "ftp", etc.
+Common schemes include "file", "http", "ftp", etc.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the URI scheme for the given
-#GFile. The returned string should be freed with g_free()
+<return> a string containing the URI scheme for the given
+#GFile. The returned string should be freed with g_free()
when no longer needed.
</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 initial elements of @file<!-- -->s pathname match @prefix.
-Only full pathname elements are matched, so a path like /foo is not
-considered a prefix of /foobar, only of /foo/bar.
+Checks whether @file has the prefix specified by @prefix.
+
+In other words, if the names of initial elements of @file's
+pathname match @prefix. Only full pathname elements are matched,
+so a path like /foo is not considered a prefix of /foobar, only
+of /foo/bar.
-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
+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.
Virtual: prefix_matches
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="prefix">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @files's parent, grandparent, etc is @prefix.
+<return> %TRUE if the @files's parent, grandparent, etc is @prefix,
%FALSE otherwise.
</return>
</function>
<description>
Checks to see if a #GFile has a given URI scheme.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="uri_scheme">
-<parameter_description> a string containing a URI scheme.
+<parameter_description> a string containing a URI scheme
</parameter_description>
</parameter>
</parameters>
<description>
Creates a hash value for a #GFile.
-This call does no blocking i/o.
+This call does no blocking I/O.
Virtual: hash
</description>
<parameters>
<parameter name="file">
-<parameter_description> #gconstpointer to a #GFile.
+<parameter_description> #gconstpointer to a #GFile
</parameter_description>
</parameter>
</parameters>
-<return> 0 if @file is not a valid #GFile, otherwise an
-integer that can be used as hash value for the #GFile.
-This function is intended for easily hashing a #GFile to
+<return> 0 if @file is not a valid #GFile, otherwise an
+integer that can be used as hash value for the #GFile.
+This function is intended for easily hashing a #GFile to
add to a #GHashTable or similar data structure.
</return>
</function>
</return>
</function>
+<function name="g_file_info_get_symbolic_icon">
+<description>
+Gets the symbolic icon for a file.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GFileInfo.
+</parameter_description>
+</parameter>
+</parameters>
+<return> #GIcon for the given @info.
+
+</return>
+</function>
+
<function name="g_file_info_get_symlink_target">
<description>
Gets the symlink target for a given #GFileInfo.
<return></return>
</function>
+<function name="g_file_info_set_symbolic_icon">
+<description>
+Sets the symbolic icon for a given #GFileInfo.
+See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GFileInfo.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GIcon.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_file_info_set_symlink_target">
<description>
Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info
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 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.
+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.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if file is native.
+<return> %TRUE if @file is native
</return>
</function>
<function name="g_file_load_contents">
<description>
-Loads the content of the file into memory. The data is always
+Loads the content of the file into memory. The data is always
zero-terminated, but this is not included in the resultant @length.
The returned @content should be freed with g_free() when no longer
needed.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="contents">
-<parameter_description> a location to place the contents of the file.
+<parameter_description> a location to place the contents of the file
</parameter_description>
</parameter>
<parameter name="length">
For more details, see g_file_load_contents() which is
the synchronous version of this call.
-When the load operation has completed, @callback will be called
-with @user data. To finish the operation, call
-g_file_load_contents_finish() with the #GAsyncResult returned by
+When the load operation has completed, @callback will be called
+with @user data. To finish the operation, call
+g_file_load_contents_finish() with the #GAsyncResult returned by
the @callback.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<function name="g_file_load_contents_finish">
<description>
-Finishes an asynchronous load of the @file's contents.
-The contents are placed in @contents, and @length is set to the
+Finishes an asynchronous load of the @file's contents.
+The contents are placed in @contents, and @length is set to the
size of the @contents string. The @content should be freed with
-g_free() when no longer needed. If @etag_out is present, it will be
+g_free() when no longer needed. If @etag_out is present, it will be
set to the new entity tag for the @file.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="contents">
-<parameter_description> a location to place the contents of the file.
+<parameter_description> a location to place the contents of the file
</parameter_description>
</parameter>
<parameter name="length">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the load was successful. If %FALSE and @error is
-present, it will be set appropriately.
+<return> %TRUE if the load was successful. If %FALSE and @error is
+present, it will be set appropriately.
</return>
</function>
<function name="g_file_load_partial_contents_async">
<description>
-Reads the partial contents of a file. A #GFileReadMoreCallback should be
-used to stop reading from the file when appropriate, else this function
-will behave exactly as g_file_load_contents_async(). This operation
-can be finished by g_file_load_partial_contents_finish().
+Reads the partial contents of a file. A #GFileReadMoreCallback should
+be used to stop reading from the file when appropriate, else this
+function will behave exactly as g_file_load_contents_async(). This
+operation can be finished by g_file_load_partial_contents_finish().
-Users of this function should be aware that @user_data is passed to
+Users of this function should be aware that @user_data is passed to
both the @read_more_callback and the @callback.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="read_more_callback">
-<parameter_description> a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
+<parameter_description> a #GFileReadMoreCallback to receive partial data
+and to specify whether further data should be read
</parameter_description>
</parameter>
<parameter name="callback">
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> the data to pass to the callback functions.
+<parameter_description> the data to pass to the callback functions
</parameter_description>
</parameter>
</parameters>
<function name="g_file_load_partial_contents_finish">
<description>
Finishes an asynchronous partial load operation that was started
-with g_file_load_partial_contents_async(). The data is always
+with g_file_load_partial_contents_async(). The data is always
zero-terminated, but this is not included in the resultant @length.
The returned @content should be freed with g_free() when no longer
needed.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="contents">
-<parameter_description> a location to place the contents of the file.
+<parameter_description> a location to place the contents of the file
</parameter_description>
</parameter>
<parameter name="length">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the load was successful. If %FALSE and @error is
-present, it will be set appropriately.
+<return> %TRUE if the load was successful. If %FALSE and @error is
+present, it will be set appropriately.
</return>
</function>
<function name="g_file_make_directory">
<description>
-Creates a directory. Note that this will only create a child directory of
-the immediate parent directory of the path or URI given by the #GFile. To
-recursively create directories, see g_file_make_directory_with_parents().
-This function will fail if the parent directory does not exist, setting
-@error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
-directories, this function will fail, setting @error to
+Creates a directory. Note that this will only create a child directory
+of the immediate parent directory of the path or URI given by the #GFile.
+To recursively create directories, see g_file_make_directory_with_parents().
+This function will fail if the parent directory does not exist, setting
+@error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
+creating directories, this function will fail, setting @error to
%G_IO_ERROR_NOT_SUPPORTED.
For a local #GFile the newly created directory will have the default
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<function name="g_file_make_directory_with_parents">
<description>
-Creates a directory and any parent directories that may not exist similar to
-'mkdir -p'. If the file system does not support creating directories, this
-function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the
-directory itself already exists, this function will fail setting @error
-to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents().
+Creates a directory and any parent directories that may not
+exist similar to 'mkdir -p'. If the file system does not support
+creating directories, this function will fail, setting @error to
+%G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
+this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
+the similar g_mkdir_with_parents().
For a local #GFile the newly created directories will have the default
(current) ownership and permissions of the current process.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Since: 2.18
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
<function name="g_file_monitor">
<description>
-Obtains a file or directory monitor for the given file, depending
-on the type of the file.
+Obtains a file or directory monitor for the given file,
+depending on the type of the file.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Since: 2.18
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileMonitor for the given @file, or %NULL on error.
+<return> a #GFileMonitor for the given @file,
+or %NULL on error.
Free the returned object with g_object_unref().
</return>
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
Virtual: monitor_dir
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileMonitorFlags.
+<parameter_description> a set of #GFileMonitorFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL.
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileMonitor for the given @file, or %NULL on error.
+<return> a #GFileMonitor for the given @file,
+or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileMonitorFlags.
+<parameter_description> a set of #GFileMonitorFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL.
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileMonitor for the given @file, or %NULL on error.
+<return> a #GFileMonitor for the given @file,
+or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_mount_enclosing_volume">
<description>
-Starts a @mount_operation, mounting the volume that contains the file @location.
+Starts a @mount_operation, mounting the volume that contains
+the file @location.
When this operation has completed, @callback will be called with
-@user_user data, and the operation can be finalized with
+@user_user data, and the operation can be finalized with
g_file_mount_enclosing_volume_finish().
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="location">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="mount_operation">
-<parameter_description> a #GMountOperation or %NULL to avoid user interaction.
+<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> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="location">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if successful. If an error
-has occurred, this function will return %FALSE and set @error
+<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_mount_mountable">
<description>
Mounts a file of type G_FILE_TYPE_MOUNTABLE.
-Using @mount_operation, you can request callbacks when, for instance,
+Using @mount_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
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.
-When the operation is finished, @callback will be called. You can then call
-g_file_mount_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_mount_mountable_finish() to get
+the result of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="mount_operation">
-<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
+<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> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
<description>
Finishes a mount operation. See g_file_mount_mountable() for details.
-Finish an asynchronous mount operation that was started
+Finish an asynchronous mount operation that was started
with g_file_mount_mountable().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_move">
<description>
-Tries to move the file or directory @source to the location specified by @destination.
-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.
+Tries to move the file or directory @source to the location specified
+by @destination. 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.
If the flag #G_FILE_COPY_OVERWRITE is specified an already
existing @destination file is overwritten.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-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 transferred with the total number of bytes
-copied during the operation.
+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
+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
+If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
error is returned, independent on the status of the @destination.
-If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
-error G_IO_ERROR_EXISTS is returned.
+If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
+then the error %G_IO_ERROR_EXISTS is returned.
-If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
+If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
error is returned. If trying to overwrite a directory with a directory the
-G_IO_ERROR_WOULD_MERGE error is returned.
+%G_IO_ERROR_WOULD_MERGE error is returned.
-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 available).
+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 available).
</description>
<parameters>
<parameter name="source">
-<parameter_description> #GFile pointing to the source location.
+<parameter_description> #GFile pointing to the source location
</parameter_description>
</parameter>
<parameter name="destination">
-<parameter_description> #GFile pointing to the destination location.
+<parameter_description> #GFile pointing to the destination location
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> set of #GFileCopyFlags.
+<parameter_description> set of #GFileCopyFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="progress_callback">
-<parameter_description> #GFileProgressCallback function for updates.
+<parameter_description> #GFileProgressCallback
+function for updates
</parameter_description>
</parameter>
<parameter name="progress_callback_data">
-<parameter_description> gpointer to user data for the callback function.
+<parameter_description> gpointer to user data for
+the callback function
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_new_for_commandline_arg">
<description>
-Creates a #GFile with the given argument from the command line. The value of
-@arg can be either a URI, an absolute path or a relative path resolved
-relative to the current working directory.
-This operation never fails, but the returned object might not support any
-I/O operation if @arg points to a malformed path.
+Creates a #GFile with the given argument from the command line.
+The value of @arg can be either a URI, an absolute path or a
+relative path resolved relative to the current working directory.
+This operation never fails, but the returned object might not
+support any I/O operation if @arg points to a malformed path.
</description>
<parameters>
<parameter name="arg">
-<parameter_description> a command line string.
+<parameter_description> a command line string
</parameter_description>
</parameter>
</parameters>
</description>
<parameters>
<parameter name="path">
-<parameter_description> a string containing a relative or absolute path. The string
-must be encoded in the glib filename encoding.
+<parameter_description> a string containing a relative or absolute path.
+The string must be encoded in the glib filename encoding.
</parameter_description>
</parameter>
</parameters>
<function name="g_file_new_for_uri">
<description>
-Constructs a #GFile for a given URI. This operation never
-fails, but the returned object might not support any I/O
-operation if @uri is malformed or if the uri type is
+Constructs a #GFile for a given URI. This operation never
+fails, but the returned object might not support any I/O
+operation if @uri is malformed or if the uri type is
not supported.
</description>
<parameters>
<parameter name="uri">
-<parameter_description> a UTF8 string containing a URI.
+<parameter_description> a UTF-8 string containing a URI
</parameter_description>
</parameter>
</parameters>
<parameters>
<parameter name="tmpl">
<parameter_description> Template for the file
-name, as in g_file_open_tmp(), or %NULL for a default template.
+name, as in g_file_open_tmp(), or %NULL for a default template
</parameter_description>
</parameter>
<parameter name="iostream">
-<parameter_description> on return, a #GFileIOStream for the created file.
+<parameter_description> on return, a #GFileIOStream for the created file
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_open_readwrite">
<description>
Opens an existing file for reading and writing. The result is
-a #GFileIOStream that can be used to read and write the contents of the file.
+a #GFileIOStream that can be used to read and write the contents
+of the file.
-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.
+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.
-If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
-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 filesystem the file is on.
-Note that in many non-local file cases read and write streams are not supported,
-so make sure you really need to do read and write streaming, rather than
-just opening for reading or writing.
+If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
+be returned. 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 filesystem the file is on. Note that in many non-local
+file cases read and write streams are not supported, so make sure you
+really need to do read and write streaming, rather than just opening
+for reading or writing.
Since: 2.22
For more details, see g_file_open_readwrite() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_open_readwrite_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_open_readwrite_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="io_priority">
<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_parse_name">
<description>
-Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
-This operation never fails, but the returned object might not support any I/O
-operation if the @parse_name cannot be parsed.
+Constructs a #GFile with the given @parse_name (i.e. something
+given by g_file_get_parse_name()). This operation never fails,
+but the returned object might not support any I/O operation if
+the @parse_name cannot be parsed.
</description>
<parameters>
<parameter name="parse_name">
-<parameter_description> a file name or path to be parsed.
+<parameter_description> a file name or path to be parsed
</parameter_description>
</parameter>
</parameters>
<function name="g_file_poll_mountable">
<description>
-Polls a file of type G_FILE_TYPE_MOUNTABLE.
+Polls a file of type #G_FILE_TYPE_MOUNTABLE.
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.
-When the operation is finished, @callback will be called. You can then call
-g_file_mount_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_mount_mountable_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> a #GFile to open.
+<parameter_description> a #GFile to open
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GAppInfo if the handle was found, %NULL if there were errors.
+<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>
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.
+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 existence 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.
+However, in many cases an existence 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 an 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> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> %TRUE if the file exists (and can be detected without error),
+%FALSE otherwise (or if cancelled).
</return>
</function>
Utility function to inspect the #GFileType of a file. This is
implemented using g_file_query_info() and as such does blocking I/O.
-The primary use case of this method is to check if a file is a regular file,
-directory, or symlink.
+The primary use case of this method is to check if a file is
+a regular file, directory, or symlink.
Since: 2.18
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileQueryInfoFlags passed to g_file_query_info().
+<parameter_description> a set of #GFileQueryInfoFlags passed to g_file_query_info()
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
-does not exist
+<return> The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
+if the file does not exist
</return>
</function>
For instance the amount of space available and the type of
the filesystem.
-The @attributes 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. @attributes should
-be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
-means all attributes, and a wildcard like "filesystem::*" means all attributes in the
-filesystem namespace. The standard namespace for filesystem attributes is "filesystem".
-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).
-
-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.
+The @attributes value is a string that specifies the 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. @attributes should be a comma-separated list of
+attributes or attribute wildcards. The wildcard "*" means all
+attributes, and a wildcard like "filesystem::*" means all attributes
+in the filesystem namespace. The standard namespace for filesystem
+attributes is "filesystem". 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).
+
+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.
-If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
-Other errors are possible too, and depend on what kind of filesystem the file is on.
+If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
+be returned. 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> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_query_filesystem_info_finish">
<description>
-Finishes an asynchronous filesystem info query. See
-g_file_query_filesystem_info_async().
+Finishes an asynchronous filesystem info query.
+See g_file_query_filesystem_info_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> #GFileInfo for given @file or %NULL on error.
+<return> #GFileInfo for given @file
+or %NULL on error.
Free the returned object with g_object_unref().
</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 @attributes 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. @attributes should
-be a comma-separated list of attributes 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.
-
-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.
+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 @attributes 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. @attributes should be a
+comma-separated list of attributes 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.
+
+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.
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.
+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, the G_IO_ERROR_NOT_FOUND error will be returned.
-Other errors are possible too, and depend on what kind of filesystem the file is on.
+If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
+returned. 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> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileQueryInfoFlags.
+<parameter_description> a set of #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileInfo for the given @file, or %NULL on error.
-Free the returned object with g_object_unref().
+<return> a #GFileInfo for the given @file, or %NULL
+on error. Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_query_info_async">
<description>
-Asynchronously gets the requested information about specified @file. The result
-is a #GFileInfo object that contains key-value attributes (such as type or size
-for the file).
+Asynchronously gets the requested information about specified @file.
+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_info() which is
-the synchronous version of this call.
+For more details, see g_file_query_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.
+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> input #GFile
</parameter_description>
</parameter>
<parameter name="attributes">
-<parameter_description> an attribute query string.
+<parameter_description> an attribute query string
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileQueryInfoFlags.
+<parameter_description> a set of #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call when the
+request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_query_info_finish">
<description>
-Finishes an asynchronous file info query.
+Finishes an asynchronous file info query.
See g_file_query_info_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError.
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> #GFileInfo for given @file or %NULL on error.
-Free the returned object with g_object_unref().
+<return> #GFileInfo for given @file
+or %NULL on error. Free the returned object with
+g_object_unref().
</return>
</function>
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter>
</parameters>
<return> a #GFileAttributeInfoList describing the settable attributes.
-When you are done with it, release it with g_file_attribute_info_list_unref()
+When you are done with it, release it with
+g_file_attribute_info_list_unref()
</return>
</function>
<function name="g_file_query_writable_namespaces">
<description>
-Obtain the list of attribute namespaces where new attributes
+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).
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter>
</parameters>
<return> a #GFileAttributeInfoList describing the writable namespaces.
-When you are done with it, release it with g_file_attribute_info_list_unref()
+When you are done with it, release it with
+g_file_attribute_info_list_unref()
</return>
</function>
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
-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 filesystem the file is on.
+If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
+returned. 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 filesystem the file is on.
Virtual: read_fn
</description>
<parameters>
<parameter name="file">
-<parameter_description> #GFile to read.
+<parameter_description> #GFile to read
</parameter_description>
</parameter>
<parameter name="cancellable">
For more details, see g_file_read() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_read_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_read_finish() to get the result
+of the operation.
</description>
<parameters>
</parameter>
<parameter name="io_priority">
<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_read_finish">
<description>
-Finishes an asynchronous file read operation started with
-g_file_read_async().
+Finishes an asynchronous file read operation started with
+g_file_read_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
will be made readable only to the current user, to the level that
is supported on the target filesystem.
-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.
+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.
-If you pass in a non-#NULL @etag value, then this value is
+If you pass in a non-%NULL @etag value, then this value is
compared to the current entity tag of the file, and if they differ
-an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
+an %G_IO_ERROR_WRONG_ETAG error is returned. This generally means
that the file has been changed since you last read it. You can get
the new etag from g_file_output_stream_get_etag() after you've
finished writing and closed the #GFileOutputStream. When you load
a new file you can use g_file_input_stream_query_info() to get
the etag of the file.
-If @make_backup is %TRUE, this function will attempt to make a backup
-of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
-error will be returned. If you want to replace anyway, try again with
-@make_backup set to %FALSE.
-
-If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
-and if the file is some other form of non-regular file then a
-G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
-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
-filesystem the file is on.
+If @make_backup is %TRUE, this function will attempt to make a
+backup of the current file before overwriting it. If this fails
+a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
+want to replace anyway, try again with @make_backup set to %FALSE.
+
+If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
+be returned, and if the file is some other form of non-regular file
+then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. 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 filesystem the file is on.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="etag">
-<parameter_description> an optional <link linkend="gfile-etag">entity tag</link> for the
-current #GFile, or #NULL to ignore.
+<parameter_description> an optional <link linkend="gfile-etag">entity tag</link>
+for the current #GFile, or #NULL to ignore
</parameter_description>
</parameter>
<parameter name="make_backup">
-<parameter_description> %TRUE if a backup should be created.
+<parameter_description> %TRUE if a backup should be created
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GFileOutputStream or %NULL on error.
+<return> a #GFileOutputStream or %NULL on error.
Free the returned object with g_object_unref().
</return>
</function>
<function name="g_file_replace_async">
<description>
-Asynchronously overwrites the file, replacing the contents, possibly
-creating a backup copy of the file first.
+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
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_replace_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_replace_finish() to get the result
+of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="etag">
-<parameter_description> an <link linkend="gfile-etag">entity tag</link> for the
-current #GFile, or NULL to ignore.
+<parameter_description> an <link linkend="gfile-etag">entity tag</link>
+for the current #GFile, or NULL to ignore
</parameter_description>
</parameter>
<parameter name="make_backup">
-<parameter_description> %TRUE if a backup should be created.
+<parameter_description> %TRUE if a backup should be created
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_replace_contents">
<description>
Replaces the contents of @file with @contents of @length bytes.
-
-If @etag is specified (not %NULL) any existing file must have that etag, or
-the error %G_IO_ERROR_WRONG_ETAG will be returned.
-If @make_backup is %TRUE, this function will attempt to make a backup of @file.
+If @etag is specified (not %NULL), any existing file must have that etag,
+or the error %G_IO_ERROR_WRONG_ETAG will be returned.
+
+If @make_backup is %TRUE, this function will attempt to make a backup
+of @file.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-The returned @new_etag can be used to verify that the file hasn't changed the
-next time it is saved over.
+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> input #GFile
</parameter_description>
</parameter>
<parameter name="contents">
-<parameter_description> a string containing the new contents for @file.
+<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> the length of @contents in bytes
</parameter_description>
</parameter>
<parameter name="etag">
-<parameter_description> the old <link linkend="gfile-etag">entity tag</link>
+<parameter_description> the old <link linkend="gfile-etag">entity tag</link>
for the document, or %NULL
</parameter_description>
</parameter>
<parameter name="make_backup">
-<parameter_description> %TRUE if a backup should be created.
+<parameter_description> %TRUE if a backup should be created
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="new_etag">
<parameter_description> a location to a new <link linkend="gfile-etag">entity tag</link>
-for the document. This should be freed with g_free() when no longer
+for the document. This should be freed with g_free() when no longer
needed, or %NULL
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</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> %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_replace_contents_async">
<description>
-Starts an asynchronous replacement of @file with the given
-@contents of @length bytes. @etag will replace the document's
+Starts an asynchronous replacement of @file with the given
+@contents of @length bytes. @etag will replace the document's
current entity tag.
When this operation has completed, @callback will be called with
-@user_user data, and the operation can be finalized with
+@user_user data, and the operation can be finalized with
g_file_replace_contents_finish().
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-If @make_backup is %TRUE, this function will attempt to
+If @make_backup is %TRUE, this function will attempt to
make a backup of @file.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="contents">
-<parameter_description> string of contents to replace the file with.
+<parameter_description> string of contents to replace the file with
</parameter_description>
</parameter>
<parameter name="length">
-<parameter_description> the length of @contents in bytes.
+<parameter_description> the length of @contents in bytes
</parameter_description>
</parameter>
<parameter name="etag">
</parameter_description>
</parameter>
<parameter name="make_backup">
-<parameter_description> %TRUE if a backup should be created.
+<parameter_description> %TRUE if a backup should be created
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<function name="g_file_replace_contents_finish">
<description>
Finishes an asynchronous replace of the given @file. See
-g_file_replace_contents_async(). Sets @new_etag to the new entity
+g_file_replace_contents_async(). Sets @new_etag to the new entity
tag for the document, if present.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="new_etag">
-<parameter_description> a location of a new <link linkend="gfile-etag">entity tag</link>
-for the document. This should be freed with g_free() when it is no
+<parameter_description> a location of a new <link linkend="gfile-etag">entity tag</link>
+for the document. This should be freed with g_free() when it is no
longer needed, or %NULL
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<function name="g_file_replace_finish">
<description>
-Finishes an asynchronous file replace operation started with
-g_file_replace_async().
+Finishes an asynchronous file replace operation started with
+g_file_replace_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
possibly creating a backup copy of the file first. If the file doesn't
exist, it will be created.
-For details about the behaviour, see g_file_replace() which does the same
-thing but returns an output stream only.
+For details about the behaviour, see g_file_replace() which does the
+same thing but returns an output stream only.
Note that in many non-local file cases read and write streams are not
supported, so make sure you really need to do read and write streaming,
</parameter_description>
</parameter>
<parameter name="etag">
-<parameter_description> an optional <link linkend="gfile-etag">entity tag</link> for the
-current #GFile, or #NULL to ignore
+<parameter_description> an optional <link linkend="gfile-etag">entity tag</link>
+for the current #GFile, or #NULL to ignore
</parameter_description>
</parameter>
<parameter name="make_backup">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_replace_readwrite_async">
<description>
-Asynchronously overwrites the file in read-write mode, replacing the
-contents, possibly creating a backup copy of the file first.
+Asynchronously overwrites the file in read-write mode,
+replacing the contents, possibly creating a backup copy
+of the file first.
For more details, see g_file_replace_readwrite() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then
-call g_file_replace_readwrite_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_replace_readwrite_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="etag">
-<parameter_description> an <link linkend="gfile-etag">entity tag</link> for the
-current #GFile, or NULL to ignore.
+<parameter_description> an <link linkend="gfile-etag">entity tag</link>
+for the current #GFile, or NULL to ignore
</parameter_description>
</parameter>
<parameter name="make_backup">
-<parameter_description> %TRUE if a backup should be created.
+<parameter_description> %TRUE if a backup should be created
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a set of #GFileCreateFlags.
+<parameter_description> a set of #GFileCreateFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<description>
Resolves a relative path for @file to an absolute path.
-This call does no blocking i/o.
+This call does no blocking I/O.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="relative_path">
-<parameter_description> a given relative path string.
+<parameter_description> a given relative path string
</parameter_description>
</parameter>
</parameters>
-<return> #GFile to the resolved path. %NULL if @relative_path
-is %NULL or if @file is invalid.
+<return> #GFile to the resolved path.
+%NULL if @relative_path is %NULL or if @file is invalid.
Free the returned object with g_object_unref().
</return>
</function>
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<parameter_description> a string containing the attribute's name
</parameter_description>
</parameter>
<parameter name="type">
</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> 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> a set of #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<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.
+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.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a string containing the attribute's new value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @attribute was successfully set to @value
+<return> %TRUE if the @attribute was successfully set to @value
in the @file, %FALSE otherwise.
</return>
</function>
<function name="g_file_set_attribute_int32">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a #gint32 containing the attribute's new value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @attribute was successfully set to @value
-in the @file, %FALSE otherwise.
+<return> %TRUE if the @attribute was successfully set to @value
+in the @file, %FALSE otherwise.
</return>
</function>
<function name="g_file_set_attribute_int64">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a #guint64 containing the attribute's new value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_set_attribute_string">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
+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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a string containing the attribute's value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> #GFileQueryInfoFlags.
+<parameter_description> #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_set_attribute_uint32">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a #guint32 containing the attribute's new value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @attribute was successfully set to @value
+<return> %TRUE if the @attribute was successfully set to @value
in the @file, %FALSE otherwise.
</return>
</function>
<function name="g_file_set_attribute_uint64">
<description>
-Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
+Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="attribute">
-<parameter_description> a string containing the attribute's name.
+<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> a #guint64 containing the attribute's new value
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @attribute was successfully set to @value
+<return> %TRUE if the @attribute was successfully set to @value
in the @file, %FALSE otherwise.
</return>
</function>
<description>
Asynchronously sets the attributes of @file with @info.
-For more details, see g_file_set_attributes_from_info() which is
-the synchronous version of this call.
+For more details, see g_file_set_attributes_from_info(),
+which is the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_set_attributes_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_set_attributes_finish() to get
+the result of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="info">
-<parameter_description> a #GFileInfo.
+<parameter_description> a #GFileInfo
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> a #GFileQueryInfoFlags.
+<parameter_description> a #GFileQueryInfoFlags
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback.
+<parameter_description> a #GAsyncReadyCallback
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> a #gpointer.
+<parameter_description> a #gpointer
</parameter_description>
</parameter>
</parameters>
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="info">
-<parameter_description> a #GFileInfo.
+<parameter_description> a #GFileInfo
</parameter_description>
</parameter>
<parameter name="error">
<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.
+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.
+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.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="info">
-<parameter_description> a #GFileInfo.
+<parameter_description> a #GFileInfo
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<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.
+The display name is converted from UTF-8 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().
+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.
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="display_name">
-<parameter_description> a string.
+<parameter_description> a string
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> a #GFile specifying what @file was renamed to, or %NULL
-if there was an error.
+<return> a #GFile specifying what @file was renamed to,
+or %NULL if there was an error.
Free the returned object with g_object_unref().
</return>
</function>
For more details, see g_file_set_display_name() which is
the synchronous version of this call.
-When the operation is finished, @callback will be called. You can then call
-g_file_set_display_name_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_set_display_name_finish() to get
+the result of the operation.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="display_name">
-<parameter_description> a string.
+<parameter_description> a string
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the <link linkend="io-priority">I/O priority</link>
-of the request.
+<parameter_description> the <link linkend="io-priority">I/O priority</link>
+of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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> a #GAsyncReadyCallback to call
+when the request is satisfied
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_set_display_name_finish">
<description>
-Finishes setting a display name started with
+Finishes setting a display name started with
g_file_set_display_name_async().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="res">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_start_mountable">
<description>
-Starts a file of type G_FILE_TYPE_MOUNTABLE.
+Starts a file of type #G_FILE_TYPE_MOUNTABLE.
Using @start_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-When the operation is finished, @callback will be called. You can then call
-g_file_mount_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_mount_mountable_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="start_operation">
-<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
+<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> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<function name="g_file_stop_mountable">
<description>
-Stops a file of type G_FILE_TYPE_MOUNTABLE.
+Stops a file of type #G_FILE_TYPE_MOUNTABLE.
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.
-When the operation is finished, @callback will be called. You can then call
-g_file_stop_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_stop_mountable_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="mount_operation">
-<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
+<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> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation finished successfully. %FALSE
-otherwise.
+<return> %TRUE if the operation finished successfully.
+%FALSE otherwise.
</return>
</function>
</description>
<parameters>
<parameter name="file">
-<parameter_description> a #GFile.
+<parameter_description> a #GFile
</parameter_description>
</parameter>
</parameters>
Not all file systems support trashing, so this call can return the
%G_IO_ERROR_NOT_SUPPORTED error.
-
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.
+was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
</description>
<parameters>
<parameter name="file">
-<parameter_description> #GFile to send to trash.
+<parameter_description> #GFile to send to trash
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
triggering the cancellable object from another thread. If the operation
was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
-When the operation is finished, @callback will be called. You can then call
-g_file_unmount_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_unmount_mountable_finish() to get
+the result of the operation.
Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<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, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
<description>
Finishes an unmount operation, see g_file_unmount_mountable() for details.
-Finish an asynchronous unmount operation that was started
+Finish an asynchronous unmount operation that was started
with g_file_unmount_mountable().
-Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
+Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
+instead.
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation finished successfully. %FALSE
-otherwise.
+<return> %TRUE if the operation finished successfully.
+%FALSE otherwise.
</return>
</function>
<function name="g_file_unmount_mountable_with_operation">
<description>
-Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
+Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
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.
-When the operation is finished, @callback will be called. You can then call
-g_file_unmount_mountable_finish() to get the result of the operation.
+When the operation is finished, @callback will be called.
+You can then call g_file_unmount_mountable_finish() to get
+the result of the operation.
Since: 2.22
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="flags">
</parameter_description>
</parameter>
<parameter name="mount_operation">
-<parameter_description> a #GMountOperation, or %NULL to avoid user interaction.
+<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> optional #GCancellable object,
+%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
+<parameter_description> a #GAsyncReadyCallback to call
+when the request is satisfied, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
<function name="g_file_unmount_mountable_with_operation_finish">
<description>
-Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
+Finishes an unmount operation,
+see g_file_unmount_mountable_with_operation() for details.
Finish an asynchronous unmount operation that was started
with g_file_unmount_mountable_with_operation().
</description>
<parameters>
<parameter name="file">
-<parameter_description> input #GFile.
+<parameter_description> input #GFile
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult.
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation finished successfully. %FALSE
-otherwise.
+<return> %TRUE if the operation finished successfully.
+%FALSE otherwise.
</return>
</function>
<return></return>
</function>
+<function name="g_menu_item_get_attribute">
+<description>
+Queries the named @attribute on @menu_item.
+
+If the attribute exists and matches the #GVariantType corresponding
+to @format_string then @format_string is used to deconstruct the
+value into the positional parameters and %TRUE is returned.
+
+If the attribute does not exist, or it does exist but has the wrong
+type, then the positional parameters are ignored and %FALSE is
+returned.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="menu_item">
+<parameter_description> a #GMenuItem
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> the attribute name to query
+</parameter_description>
+</parameter>
+<parameter name="format_string">
+<parameter_description> a #GVariant format string
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> positional parameters, as per @format_string
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the named attribute was found with the expected
+type
+
+</return>
+</function>
+
+<function name="g_menu_item_get_attribute_value">
+<description>
+Queries the named @attribute on @menu_item.
+
+If @expected_type is specified and the attribute does not have this
+type, %NULL is returned. %NULL is also returned if the attribute
+simply does not exist.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="menu_item">
+<parameter_description> a #GMenuItem
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> the attribute name to query
+</parameter_description>
+</parameter>
+<parameter name="expected_type">
+<parameter_description> the expected type of the attribute
+</parameter_description>
+</parameter>
+</parameters>
+<return> the attribute value, or %NULL
+
+</return>
+</function>
+
+<function name="g_menu_item_get_link">
+<description>
+Queries the named @link on @menu_item.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="menu_item">
+<parameter_description> a #GMenuItem
+</parameter_description>
+</parameter>
+<parameter name="link">
+<parameter_description> the link name to query
+</parameter_description>
+</parameter>
+</parameters>
+<return> the link, or %NULL
+
+</return>
+</function>
+
<function name="g_menu_item_new">
<description>
Creates a new #GMenuItem.
</return>
</function>
+<function name="g_menu_item_new_from_model">
+<description>
+Creates a #GMenuItem as an exact copy of an existing menu item in a
+#GMenuModel.
+
+@item_index must be valid (ie: be sure to call
+g_menu_model_get_n_items() first).
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #GMenuModel
+</parameter_description>
+</parameter>
+<parameter name="item_index">
+<parameter_description> the index of an item in @model
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GMenuItem.
+
+</return>
+</function>
+
<function name="g_menu_item_new_section">
<description>
Creates a new #GMenuItem representing a section.
type, then the positional parameters are ignored and %FALSE is
returned.
+This function is a mix of g_menu_model_get_item_attribute_value() and
+g_variant_get(), followed by a g_variant_unref(). As such,
+@format_string must make a complete copy of the data (since the
+#GVariant may go away after the call to g_variant_unref()). In
+particular, no '&' characters are allowed in @format_string.
+
Since: 2.32
</description>
</return>
</function>
+<function name="g_mount_get_symbolic_icon">
+<description>
+Gets the symbolic icon for @mount.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="mount">
+<parameter_description> a #GMount.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GIcon.
+The returned object should be unreffed with
+g_object_unref() when no longer needed.
+
+</return>
+</function>
+
<function name="g_mount_get_uuid">
<description>
Gets the UUID for the @mount. The reference is typically based on
</parameter_description>
</parameter>
<parameter name="dest_hostname">
-<parameter_description> The destination hostname the the proxy should tunnel to.
+<parameter_description> The destination hostname the proxy should tunnel to.
</parameter_description>
</parameter>
<parameter name="dest_port">
<function name="g_resources_enumerate_children">
<description>
Returns all the names of children at the specified @path in the set of
-globally registred resources.
+globally registered resources.
The return result is a %NULL terminated list of strings which should
be released with g_strfreev().
<function name="g_resources_get_info">
<description>
Looks for a file at the specified @path in the set of
-globally registred resources and if found returns information about it.
+globally registered resources and if found returns information about it.
@lookup_flags controls the behaviour of the lookup.
<function name="g_resources_lookup_data">
<description>
Looks for a file at the specified @path in the set of
-globally registred resources and returns a #GBytes that
+globally registered resources and returns a #GBytes that
lets you directly access the data in memory.
The data is always followed by a zero byte, so you
<function name="g_resources_open_stream">
<description>
Looks for a file at the specified @path in the set of
-globally registred resources and returns a #GInputStream
+globally registered resources and returns a #GInputStream
that lets you read the data.
@lookup_flags controls the behaviour of the lookup.
source, the lookup will recurse to the parent.
Second, any references to other schemas specified within this
-source (ie: <literal>child</literal> or <literal>extents</literal>)
+source (ie: <literal>child</literal> or <literal>extends</literal>)
references may be resolved from the @parent.
For this second reason, except in very unusual situations, the
<function name="g_socket_get_fd">
<description>
Returns the underlying OS socket object. On unix this
-is a socket file descriptor, and on windows this is
+is a socket file descriptor, and on Windows this is
a Winsock2 SOCKET handle. This may be useful for
doing platform specific or otherwise unusual operations
on the socket.
<function name="g_static_resource_get_resource">
<description>
-Gets the GResource that was registred by a call to g_static_resource_init().
+Gets the GResource that was registered by a call to g_static_resource_init().
This is normally used by code generated by
<link linkend="glib-compile-resources">glib-compile-resources</link>
</return>
</function>
+<function name="g_tls_certificate_is_same">
+<description>
+Check if two #GTlsCertificate objects represent the same certificate.
+The raw DER byte data of the two certificates are checked for equality.
+This has the effect that two certificates may compare equal even if
+their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or
+#GTlsCertificate:private-key-pem properties differ.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="cert_one">
+<parameter_description> first certificate to compare
+</parameter_description>
+</parameter>
+<parameter name="cert_two">
+<parameter_description> second certificate to compare
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether the same or not
+
+</return>
+</function>
+
<function name="g_tls_certificate_list_new_from_file">
<description>
Creates one or more #GTlsCertificate<!-- -->s from the PEM-encoded
</return>
</function>
+<function name="g_unix_mount_guess_symbolic_icon">
+<description>
+Guesses the symbolic icon of a Unix mount.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="mount_entry">
+<parameter_description> a #GUnixMountEntry
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GIcon
+
+</return>
+</function>
+
<function name="g_unix_mount_is_readonly">
<description>
Checks if a unix mount is mounted read only.
</return>
</function>
+<function name="g_unix_mount_point_guess_symbolic_icon">
+<description>
+Guesses the symbolic icon of a Unix mount point.
+
+Since: 2.34
+
+</description>
+<parameters>
+</parameters>
+<return> a #GIcon
+
+</return>
+</function>
+
<function name="g_unix_mount_point_is_loopback">
<description>
Checks if a unix mount point is a loopback device.
<function name="g_unix_socket_address_abstract_names_supported">
<description>
-Checks if abstract unix domain socket names are supported.
+Checks if abstract UNIX domain socket names are supported.
Since: 2.22
</return>
</function>
+<function name="g_volume_get_symbolic_icon">
+<description>
+Gets the symbolic icon for @volume.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="volume">
+<parameter_description> a #GVolume.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GIcon.
+The returned object should be unreffed with g_object_unref()
+when no longer needed.
+
+</return>
+</function>
+
<function name="g_volume_get_uuid">
<description>
Gets the UUID for the @volume. The reference is typically based on
you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
the spawn function for the child watching to work.
-Note that on platforms where #GPid must be explicitly closed
-(see g_spawn_close_pid()) @pid must not be closed while the
-source is still active. Typically, you will want to call
-g_spawn_close_pid() in the callback function for the source.
+In many programs, you will want to call g_spawn_check_exit_status()
+in the callback to determine whether or not the child exited
+successfully.
+
+Also, note that on platforms where #GPid must be explicitly closed
+(see g_spawn_close_pid()) @pid must not be closed while the source
+is still active. Typically, you should invoke g_spawn_close_pid()
+in the callback function for the source.
GLib supports only a single callback per process id.
<function name="g_completion_clear_items">
<description>
-Removes all items from the #GCompletion.
+Removes all items from the #GCompletion. The items are not freed, so if the
+memory was dynamically allocated, it should be freed after calling this
+function.
Deprecated: 2.26: Rarely used API
</parameter_description>
</parameter>
</parameters>
-<return> the list of items whose strings begin with @prefix. This
-should not be changed.
+<return> the list of items whose strings begin with
+@prefix. This should not be changed.
</return>
</function>
<function name="g_completion_free">
<description>
-Frees all memory used by the #GCompletion.
+Frees all memory used by the #GCompletion. The items are not freed, so if
+the memory was dynamically allocated, it should be freed after calling this
+function.
Deprecated: 2.26: Rarely used API
<function name="g_completion_remove_items">
<description>
-Removes items from a #GCompletion.
+Removes items from a #GCompletion. The items are not freed, so if the memory
+was dynamically allocated, free @items with g_list_free_full() after calling
+this function.
Deprecated: 2.26: Rarely used API
<return></return>
</function>
+<function name="g_compute_checksum_for_bytes">
+<description>
+Computes the checksum for a binary @data. This is a
+convenience wrapper for g_checksum_new(), g_checksum_get_string()
+and g_checksum_free().
+
+The hexadecimal string returned will be in lower case.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="checksum_type">
+<parameter_description> a #GChecksumType
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> binary blob to compute the digest of
+</parameter_description>
+</parameter>
+</parameters>
+<return> the digest of the binary data as a string in hexadecimal.
+The returned string should be freed with g_free() when done using it.
+
+</return>
+</function>
+
<function name="g_compute_checksum_for_data">
<description>
Computes the checksum for a binary @data of @length. This is a
Calling g_cond_free() for a #GCond on which threads are
blocking leads to undefined behaviour.
-Deprecated:3.32:GCond can now be statically allocated, or embedded
+Deprecated: 2.32: GCond can now be statically allocated, or embedded
in structures and initialised with g_cond_init().
</description>
<description>
Allocates and initializes a new #GCond.
-Deprecated:3.32:GCond can now be statically allocated, or embedded
+Deprecated: 2.32: GCond can now be statically allocated, or embedded
in structures and initialised with g_cond_init().
</description>
</return>
</function>
+<function name="g_datalist_id_dup_data">
+<description>
+This is a variant of g_datalist_id_get_data() which
+returns a 'duplicate' of the value. @dup_func defines the
+meaning of 'duplicate' in this context, it could e.g.
+take a reference on a ref-counted object.
+
+If the @key_id is not set in the datalist then @dup_func
+will be called with a %NULL argument.
+
+Note that @dup_func is called while the datalist is locked, so it
+is not allowed to read or modify the datalist.
+
+This function can be useful to avoid races when multiple
+threads are using the same datalist and the same key.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="datalist">
+<parameter_description> location of a datalist
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark identifying a data element
+</parameter_description>
+</parameter>
+<parameter name="dup_func">
+<parameter_description> function to duplicate the old value
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> passed as user_data to @dup_func
+</parameter_description>
+</parameter>
+</parameters>
+<return> the result of calling @dup_func on the value
+associated with @key_id in @datalist, or %NULL if not set.
+If @dup_func is %NULL, the value is returned unmodified.
+
+</return>
+</function>
+
<function name="g_datalist_id_get_data">
<description>
Retrieves the data element corresponding to @key_id.
+
</description>
<parameters>
<parameter name="datalist">
</return>
</function>
+<function name="g_datalist_id_replace_data">
+<description>
+Compares the member that is associated with @key_id in
+@datalist to @oldval, and if they are the same, replace
+@oldval with @newval.
+
+This is like a typical atomic compare-and-exchange
+operation, for a member of @datalist.
+
+If the previous value was replaced then ownership of the
+old value (@oldval) is passed to the caller, including
+the registred destroy notify for it (passed out in @old_destroy).
+Its up to the caller to free this as he wishes, which may
+or may not include using @old_destroy as sometimes replacement
+should not destroy the object in the normal way.
+
+Return: %TRUE if the existing value for @key_id was replaced
+by @newval, %FALSE otherwise.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="datalist">
+<parameter_description> location of a datalist
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark identifying a data element
+</parameter_description>
+</parameter>
+<parameter name="oldval">
+<parameter_description> the old value to compare against
+</parameter_description>
+</parameter>
+<parameter name="newval">
+<parameter_description> the new value to replace it with
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> destroy notify for the new value
+</parameter_description>
+</parameter>
+<parameter name="old_destroy">
+<parameter_description> destroy notify for the existing value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_datalist_id_set_data">
<description>
Sets the data corresponding to the given #GQuark id. Any previous
Retrieves the name of another entry in the directory, or %NULL.
The order of entries returned from this function is not defined,
and may vary by file system or other operating-system dependent
-factors.
+factors.
+
+%NULL may also be returned in case of errors. On Unix, you can
+check <literal>errno</literal> to find out if %NULL was returned
+because of an error.
On Unix, the '.' and '..' entries are omitted, and the returned
name is in the on-disk encoding.
</parameter_description>
</parameter>
</parameters>
-<return> The entry's name or %NULL if there are no
+<return> The entry's name or %NULL if there are no
more entries. The return value is owned by GLib and
must not be modified or freed.
</return>
</parameter_description>
</parameter>
</parameters>
-<return> absolute path, or %NULL
+<return> a newly-allocated string with the absolute path, or %NULL
</return>
</function>
<function name="g_intern_static_string">
<description>
-Returns a canonical representation for @string. Interned strings can
-be compared for equality by comparing the pointers, instead of using strcmp().
-g_intern_static_string() does not copy the string, therefore @string must
-not be freed or modified.
+Returns a canonical representation for @string. Interned strings
+can be compared for equality by comparing the pointers, instead of
+using strcmp(). g_intern_static_string() does not copy the string,
+therefore @string must not be freed or modified.
Since: 2.10
<function name="g_intern_string">
<description>
-Returns a canonical representation for @string. Interned strings can
-be compared for equality by comparing the pointers, instead of using strcmp().
+Returns a canonical representation for @string. Interned strings
+can be compared for equality by comparing the pointers, instead of
+using strcmp().
Since: 2.10
<note><para>
Note that this is a "shallow" copy. If the list elements
consist of pointers to data, the pointers are copied but
-the actual data is not.
+the actual data is not. See g_list_copy_deep() if you need
+to copy the data as well.
</para></note>
</return>
</function>
+<function name="g_list_copy_deep">
+<description>
+Makes a full (deep) copy of a #GList.
+
+In contrast with g_list_copy(), this function uses @func to make a copy of
+each list element, in addition to copying the list container itself.
+
+@func, as a #GCopyFunc, takes two arguments, the data to be copied and a user
+pointer. It's safe to pass #NULL as user_data, if the copy function takes only
+one argument.
+
+For instance, if @list holds a list of GObjects, you can do:
+|[
+another_list = g_list_copy_deep (list, (GCopyFunc) g_object_ref, NULL);
+]|
+
+And, to entirely free the new list, you could do:
+|[
+g_list_free_full (another_list, g_object_unref);
+]|
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a copy function used to copy every element in the list
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to the copy function @func, or #NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a full copy of @list, use #g_list_free_full to free it
+
+</return>
+</function>
+
<function name="g_list_delete_link">
<description>
Removes the node link_ from the list and frees it.
checking to see if any event sources are ready to be processed,
then if no events sources are ready and @may_block is %TRUE, waiting
for a source to become ready, then dispatching the highest priority
-events sources that are ready. Otherwise, if @may_block is %FALSE
-sources are not waited to become ready, only those highest priority
-events sources will be dispatched (if any), that are ready at this
+events sources that are ready. Otherwise, if @may_block is %FALSE
+sources are not waited to become ready, only those highest priority
+events sources will be dispatched (if any), that are ready at this
given moment without further waiting.
-Note that even when @may_block is %TRUE, it is still possible for
-g_main_context_iteration() to return %FALSE, since the the wait may
+Note that even when @may_block is %TRUE, it is still possible for
+g_main_context_iteration() to return %FALSE, since the wait may
be interrupted for other reasons than an event source becoming ready.
<return></return>
</function>
+<function name="g_mapped_file_get_bytes">
+<description>
+Creates a new #GBytes which references the data mapped from @file.
+The mapped contents of the file must not be modified after creating this
+bytes object, because a #GBytes should be immutable.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="file">
+<parameter_description> a #GMappedFile
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GBytes referencing data
+from @file
+
+</return>
+</function>
+
<function name="g_mapped_file_get_contents">
<description>
Returns the contents of a #GMappedFile.
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of gchar * pointers.
-It must be freed using g_strfreev(). If the previous match failed
-%NULL is returned
+<return> a %NULL-terminated array of gchar *
+pointers. It must be freed using g_strfreev(). If the previous
+match failed %NULL is returned
</return>
</function>
able to raise an error as soon as a mistake is made.
GRegex supports the concept of partial matching by means of the
-#G_REGEX_MATCH_PARTIAL flag. When this is set the return code for
+#G_REGEX_MATCH_PARTIAL_SOFT and #G_REGEX_MATCH_PARTIAL_HARD flags.
+When they are used, the return code for
g_regex_match() or g_regex_match_full() is, as usual, %TRUE
for a complete match, %FALSE otherwise. But, when these functions
return %FALSE, you can check if the match was partial calling
g_match_info_is_partial_match().
-When using partial matching you cannot use g_match_info_fetch*().
+The difference between #G_REGEX_MATCH_PARTIAL_SOFT and
+#G_REGEX_MATCH_PARTIAL_HARD is that when a partial match is encountered
+with #G_REGEX_MATCH_PARTIAL_SOFT, matching continues to search for a
+possible complete match, while with #G_REGEX_MATCH_PARTIAL_HARD matching
+stops at the partial match.
+When both #G_REGEX_MATCH_PARTIAL_SOFT and #G_REGEX_MATCH_PARTIAL_HARD
+are set, the latter takes precedence.
+See <ulink>man:pcrepartial</ulink> for more information on partial matching.
Because of the way certain internal optimizations are implemented
the partial matching algorithm cannot be used with all patterns.
of occurrences is greater than one. Optional items such as "\d?"
(where the maximum is one) are permitted. Quantifiers with any values
are permitted after parentheses, so the invalid examples above can be
-coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL is set
+coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL or
+#G_REGEX_MATCH_PARTIAL_HARD is set
for a pattern that does not conform to the restrictions, matching
functions return an error.
</return>
</function>
-<function name="g_module_name">
+<function name="g_module_make_resident">
<description>
Ensures that a module will never be unloaded.
Any future g_module_close() calls on the module will be ignored.
<return></return>
</function>
+<function name="g_module_name">
+<description>
+Returns the filename that the module was opened with.
+
+If @module refers to the application itself, "main" is returned.
+
+
+</description>
+<parameters>
+<parameter name="module">
+<parameter_description> a #GModule
+</parameter_description>
+</parameter>
+</parameters>
+<return> the filename of the module
+</return>
+</function>
+
<function name="g_module_open">
<description>
Opens a module. If the module has already been opened,
Calling g_mutex_free() on a locked mutex may result
in undefined behaviour.
-Deprecated:3.32:GMutex can now be statically allocated, or embedded
+Deprecated: 2.32: GMutex can now be statically allocated, or embedded
in structures and initialised with g_mutex_init().
</description>
This function is useful to initialize a mutex that has been
allocated on the stack, or as part of a larger structure.
It is not necessary to initialize a mutex that has been
-created that has been statically allocated.
+statically allocated.
|[
typedef struct {
<description>
Allocates and initializes a new #GMutex.
-Deprecated:3.32:GMutex can now be statically allocated, or embedded
+Deprecated: 2.32: GMutex can now be statically allocated, or embedded
in structures and initialised with g_mutex_init().
</description>
<return></return>
</function>
+<function name="g_object_dup_data">
+<description>
+This is a variant of g_object_get_data() which returns
+a 'duplicate' of the value. @dup_func defines the
+meaning of 'duplicate' in this context, it could e.g.
+take a reference on a ref-counted object.
+
+If the @key is not set on the object then @dup_func
+will be called with a %NULL argument.
+
+Note that @dup_func is called while user data of @object
+is locked.
+
+This function can be useful to avoid races when multiple
+threads are using object data on the same key on the same
+object.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> the #GObject to store user data on
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a string, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="dup_func">
+<parameter_description> function to dup the value
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> passed as user_data to @dup_func
+</parameter_description>
+</parameter>
+</parameters>
+<return> the result of calling @dup_func on the value
+associated with @key on @object, or %NULL if not set.
+If @dup_func is %NULL, the value is returned
+unmodified.
+
+</return>
+</function>
+
+<function name="g_object_dup_qdata">
+<description>
+This is a variant of g_object_get_qdata() which returns
+a 'duplicate' of the value. @dup_func defines the
+meaning of 'duplicate' in this context, it could e.g.
+take a reference on a ref-counted object.
+
+If the @quark is not set on the object then @dup_func
+will be called with a %NULL argument.
+
+Note that @dup_func is called while user data of @object
+is locked.
+
+This function can be useful to avoid races when multiple
+threads are using object data on the same key on the same
+object.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> the #GObject to store user data on
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="dup_func">
+<parameter_description> function to dup the value
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> passed as user_data to @dup_func
+</parameter_description>
+</parameter>
+</parameters>
+<return> the result of calling @dup_func on the value
+associated with @quark on @object, or %NULL if not set.
+If @dup_func is %NULL, the value is returned
+unmodified.
+
+</return>
+</function>
+
<function name="g_object_force_floating">
<description>
This function is intended for #GObject implementations to re-enforce a
<return></return>
</function>
+<function name="g_object_replace_data">
+<description>
+Compares the user data for the key @key on @object with
+@oldval, and if they are the same, replaces @oldval with
+@newval.
+
+This is like a typical atomic compare-and-exchange
+operation, for user data on an object.
+
+If the previous value was replaced then ownership of the
+old value (@oldval) is passed to the caller, including
+the registred destroy notify for it (passed out in @old_destroy).
+Its up to the caller to free this as he wishes, which may
+or may not include using @old_destroy as sometimes replacement
+should not destroy the object in the normal way.
+
+Return: %TRUE if the existing value for @key was replaced
+by @newval, %FALSE otherwise.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> the #GObject to store user data on
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a string, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="oldval">
+<parameter_description> the old value to compare against
+</parameter_description>
+</parameter>
+<parameter name="newval">
+<parameter_description> the new value
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> a destroy notify for the new value
+</parameter_description>
+</parameter>
+<parameter name="old_destroy">
+<parameter_description> destroy notify for the existing value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_object_replace_qdata">
+<description>
+Compares the user data for the key @quark on @object with
+@oldval, and if they are the same, replaces @oldval with
+@newval.
+
+This is like a typical atomic compare-and-exchange
+operation, for user data on an object.
+
+If the previous value was replaced then ownership of the
+old value (@oldval) is passed to the caller, including
+the registred destroy notify for it (passed out in @old_destroy).
+Its up to the caller to free this as he wishes, which may
+or may not include using @old_destroy as sometimes replacement
+should not destroy the object in the normal way.
+
+Return: %TRUE if the existing value for @quark was replaced
+by @newval, %FALSE otherwise.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="object">
+<parameter_description> the #GObject to store user data on
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="oldval">
+<parameter_description> the old value to compare against
+</parameter_description>
+</parameter>
+<parameter name="newval">
+<parameter_description> the new value
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> a destroy notify for the new value
+</parameter_description>
+</parameter>
+<parameter name="old_destroy">
+<parameter_description> destroy notify for the existing value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_object_run_dispose">
<description>
Releases all references to other objects. This can be used to break
expect to ever unload the module again (e.g. do not use this
function in GTK+ theme engines).
+
</description>
<parameters>
<parameter name="string">
not currently have an associated #GQuark, a new #GQuark is created,
using a copy of the string.
+
</description>
<parameters>
<parameter name="string">
<description>
Gets the string associated with the given #GQuark.
+
</description>
<parameters>
<parameter name="quark">
</parameter_description>
</parameter>
</parameters>
-<return> the string associated with the #GQuark.
+<return> the string associated with the #GQuark
</return>
</function>
</return>
</function>
+<function name="g_regex_get_has_cr_or_lf">
+<description>
+Checks whether the pattern contains explicit CR or LF references.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the pattern contains explicit CR or LF references
+
+</return>
+</function>
+
<function name="g_regex_get_match_flags">
<description>
Returns the match options that @regex was created with.
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+<return> a %NULL-terminated gchar ** array. Free
+it using g_strfreev()
</return>
</function>
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+<return> a %NULL-terminated gchar ** array. Free
+it using g_strfreev()
</return>
</function>
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of strings. Free it using g_strfreev()
+<return> a %NULL-terminated array of strings. Free
+it using g_strfreev()
</return>
</function>
<note><para>
Note that this is a "shallow" copy. If the list elements
consist of pointers to data, the pointers are copied but
-the actual data isn't.
+the actual data isn't. See g_slist_copy_deep() if you need
+to copy the data as well.
</para></note>
</return>
</function>
+<function name="g_slist_copy_deep">
+<description>
+Makes a full (deep) copy of a #GSList.
+
+In contrast with g_slist_copy(), this function uses @func to make a copy of
+each list element, in addition to copying the list container itself.
+
+@func, as a #GCopyFunc, takes two arguments, the data to be copied and a user
+pointer. It's safe to pass #NULL as user_data, if the copy function takes only
+one argument.
+
+For instance, if @list holds a list of GObjects, you can do:
+|[
+another_list = g_slist_copy_deep (list, (GCopyFunc) g_object_ref, NULL);
+]|
+
+And, to entirely free the new list, you could do:
+|[
+g_slist_free_full (another_list, g_object_unref);
+]|
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a copy function used to copy every element in the list
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to the copy function @func, or #NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a full copy of @list, use #g_slist_free_full to free it
+
+</return>
+</function>
+
<function name="g_slist_delete_link">
<description>
Removes the node link_ from the list and frees it.
Compare this to g_slist_remove_link() which removes the node
without freeing it.
+<note>Removing arbitrary nodes from a singly-linked list
+requires time that is proportional to the length of the list
+(ie. O(n)). If you find yourself using g_slist_delete_link()
+frequently, you should consider a different data structure, such
+as the doubly-linked #GList.</note>
+
</description>
<parameters>
link is set to %NULL, so that it becomes a
self-contained list with one element.
+<note>Removing arbitrary nodes from a singly-linked list
+requires time that is proportional to the length of the list
+(ie. O(n)). If you find yourself using g_slist_remove_link()
+frequently, you should consider a different data structure, such
+as the doubly-linked #GList.</note>
+
</description>
<parameters>
<function name="g_source_get_context">
<description>
Gets the #GMainContext with which the source is associated.
-Calling this function on a destroyed source is an error.
+
+You can call this on a source that has been destroyed, provided
+that the #GMainContext it was attached to still exists (in which
+case it will return that #GMainContext). In particular, you can
+always call this function on the source returned from
+g_main_current_source(). But calling this function on a source
+whose #GMainContext has been destroyed is an error.
</description>
</return>
</function>
+<function name="g_spawn_check_exit_status">
+<description>
+Set @error if @exit_status indicates the child exited abnormally
+(e.g. with a nonzero exit code, or via a fatal signal).
+
+The g_spawn_sync() and g_child_watch_add() family of APIs return an
+exit status for subprocesses encoded in a platform-specific way.
+On Unix, this is guaranteed to be in the same format
+<literal>waitpid(2)</literal> returns, and on Windows it is
+guaranteed to be the result of
+<literal>GetExitCodeProcess()</literal>. Prior to the introduction
+of this function in GLib 2.34, interpreting @exit_status required
+use of platform-specific APIs, which is problematic for software
+using GLib as a cross-platform layer.
+
+Additionally, many programs simply want to determine whether or not
+the child exited successfully, and either propagate a #GError or
+print a message to standard error. In that common case, this
+function can be used. Note that the error message in @error will
+contain human-readable information about the exit status.
+
+The <literal>domain</literal> and <literal>code</literal> of @error
+have special semantics in the case where the process has an "exit
+code", as opposed to being killed by a signal. On Unix, this
+happens if <literal>WIFEXITED</literal> would be true of
+@exit_status. On Windows, it is always the case.
+
+The special semantics are that the actual exit code will be the
+code set in @error, and the domain will be %G_SPAWN_EXIT_ERROR.
+This allows you to differentiate between different exit codes.
+
+If the process was terminated by some means other than an exit
+status, the domain will be %G_SPAWN_ERROR, and the code will be
+%G_SPAWN_ERROR_FAILED.
+
+This function just offers convenience; you can of course also check
+the available platform via a macro such as %G_OS_UNIX, and use
+<literal>WIFEXITED()</literal> and <literal>WEXITSTATUS()</literal>
+on @exit_status directly. Do not attempt to scan or parse the
+error message string; it may be translated and/or change in future
+versions of GLib.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="exit_status">
+<parameter_description> An exit code as returned from g_spawn_sync()
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if child exited successfully, %FALSE otherwise (and @error will be set)
+</return>
+</function>
+
<function name="g_spawn_close_pid">
<description>
On some platforms, notably Windows, the #GPid type represents a resource
appropriate. Possible errors are those from g_spawn_sync() and those
from g_shell_parse_argv().
-If @exit_status is non-%NULL, the exit status of the child is stored there as
-it would be returned by waitpid(); standard UNIX macros such as WIFEXITED()
-and WEXITSTATUS() must be used to evaluate the exit status.
+If @exit_status is non-%NULL, the platform-specific exit status of
+the child is stored there; see the documentation of
+g_spawn_check_exit_status() for how to use and interpret this.
On Windows, please note the implications of g_shell_parse_argv()
parsing @command_line. Parsing is done according to Unix shell rules, not
if those parameters are non-%NULL. Note that you must set the
%G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when
passing %NULL for @standard_output and @standard_error.
-If @exit_status is non-%NULL, the exit status of the child is stored
-there as it would be returned by waitpid(); standard UNIX macros such
-as WIFEXITED() and WEXITSTATUS() must be used to evaluate the exit status.
-Note that this function call waitpid() even if @exit_status is %NULL, and
-does not accept the %G_SPAWN_DO_NOT_REAP_CHILD flag.
-If an error occurs, no data is returned in @standard_output,
-@standard_error, or @exit_status.
+
+If @exit_status is non-%NULL, the platform-specific exit status of
+the child is stored there; see the doucumentation of
+g_spawn_check_exit_status() for how to use and interpret this.
+Note that it is invalid to pass %G_SPAWN_DO_NOT_REAP_CHILD in
+@flags.
+
+If an error occurs, no data is returned in @standard_output,
+@standard_error, or @exit_status.
This function calls g_spawn_async_with_pipes() internally; see that
function for full details on the other parameters and details on
</return>
</function>
+<function name="g_string_free_to_bytes">
+<description>
+Transfers ownership of the contents of @string to a newly allocated
+#GBytes. The #GString structure itself is deallocated, and it is
+therefore invalid to use @string after invoking this function.
+
+Note that while #GString ensures that its buffer always has a
+trailing nul character (not reflected in its "len"), the returned
+#GBytes does not include this extra nul; i.e. it has length exactly
+equal to the "len" member.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GBytes containing contents of @string; @string itself is freed
+</return>
+</function>
+
<function name="g_string_hash">
<description>
Creates a hash code for @str; for use with #GHashTable.
<return></return>
</function>
+<function name="g_test_add_data_func_full">
+<description>
+Create a new test case, as with g_test_add_data_func(), but freeing
+@test_data after the test run is complete.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="testpath">
+<parameter_description> /-separated test case path name for the test.
+</parameter_description>
+</parameter>
+<parameter name="test_data">
+<parameter_description> Test data argument for the test function.
+</parameter_description>
+</parameter>
+<parameter name="test_func">
+<parameter_description> The test function to invoke for this test.
+</parameter_description>
+</parameter>
+<parameter name="data_free_func">
+<parameter_description> #GDestroyNotify for @test_data.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_test_add_func">
<description>
Create a new test case, similar to g_test_create_case(). However
<return></return>
</function>
+<function name="g_test_assert_expected_messages">
+<description>
+Asserts that all messages previously indicated via
+g_test_expect_message() have been seen and suppressed.
+
+Since: 2.34
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
<function name="g_test_bug">
<description>
This function adds a message to test reports that
</return>
</function>
+<function name="g_test_expect_message">
+<description>
+Indicates that a message with the given @log_domain and @log_level,
+with text matching @pattern, is expected to be logged. When this
+message is logged, it will not be printed, and the test case will
+not abort.
+
+Use g_test_assert_expected_messages() to assert that all
+previously-expected messages have been seen and suppressed.
+
+You can call this multiple times in a row, if multiple messages are
+expected as a result of a single call. (The messages must appear in
+the same order as the calls to g_test_expect_message().)
+
+For example:
+
+|[
+/ * g_main_context_push_thread_default() should fail if the
+* context is already owned by another thread.
+* /
+g_test_expect_message (G_LOG_DOMAIN,
+G_LOG_LEVEL_CRITICIAL,
+"assertion.*acquired_context.*failed");
+g_main_context_push_thread_default (bad_context);
+g_test_assert_expected_messages ();
+]|
+
+Note that you cannot use this to test g_error() messages, since
+g_error() intentionally never returns even if the program doesn't
+abort; use g_test_trap_fork() in this case.
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="log_domain">
+<parameter_description> the log domain of the message
+</parameter_description>
+</parameter>
+<parameter name="log_level">
+<parameter_description> the log level of the message
+</parameter_description>
+</parameter>
+<parameter name="pattern">
+<parameter_description> a glob-style
+<link linkend="glib-Glob-style-pattern-matching">pattern</link>
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="g_test_fail">
<description>
Indicates that a test failed. This function can be called
<varlistentry>
<term><option>-l</option></term>
<listitem><para>
-list test cases available in a test executable.
+List test cases available in a test executable.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
<listitem><para>
-provide a random seed to reproduce test runs using random numbers.
+Provide a random seed to reproduce test runs using random numbers.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
-<listitem><para>run tests verbosely.</para></listitem>
+<listitem><para>Run tests verbosely.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option>, <option>--quiet</option></term>
-<listitem><para>run tests quietly.</para></listitem>
+<listitem><para>Run tests quietly.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>TESTPATH</replaceable></option></term>
<listitem><para>
-execute all tests matching <replaceable>TESTPATH</replaceable>.
+Execute all tests matching <replaceable>TESTPATH</replaceable>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
<listitem><para>
-execute tests according to these test modes:
+Execute tests according to these test modes:
<variablelist>
<varlistentry>
<term>perf</term>
<listitem><para>
-performance tests, may take long and report results.
+Performance tests, may take long and report results.
</para></listitem>
</varlistentry>
<varlistentry>
<term>slow, thorough</term>
<listitem><para>
-slow and thorough tests, may take quite long and
+Slow and thorough tests, may take quite long and
maximize coverage.
</para></listitem>
</varlistentry>
<varlistentry>
<term>quick</term>
<listitem><para>
-quick tests, should run really quickly and give good coverage.
+Quick tests, should run really quickly and give good coverage.
</para></listitem>
</varlistentry>
<varlistentry>
<term>undefined</term>
<listitem><para>
-tests for undefined behaviour, may provoke programming errors
+Tests for undefined behaviour, may provoke programming errors
under g_test_trap_fork() to check that appropriate assertions
or warnings are given
</para></listitem>
<varlistentry>
<term>no-undefined</term>
<listitem><para>
-avoid tests for undefined behaviour
+Avoid tests for undefined behaviour
</para></listitem>
</varlistentry>
</variablelist>
</varlistentry>
<varlistentry>
<term><option>--debug-log</option></term>
-<listitem><para>debug test logging output.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-k</option>, <option>--keep-going</option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
+<listitem><para>Debug test logging output.</para></listitem>
</varlistentry>
</variablelist>
By setting @interval to 0, idle threads will not be stopped.
-This function makes use of g_async_queue_timed_pop () using
-@interval.
+The default value is 15000 (15 seconds).
Since: 2.10
If @max_threads is -1, no limit is imposed on the number
of unused threads.
+The default value is 2.
+
</description>
<parameters>
<parameter name="max_threads">
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated %NULL-terminated list of
-strings holding the individual URIs. The array should
-be freed with g_strfreev().
+<return> a newly allocated %NULL-terminated list
+of strings holding the individual URIs. The array should be freed
+with g_strfreev().
</return>
</function>
</return>
</function>
+<function name="g_variant_check_format_string">
+<description>
+Checks if calling g_variant_get() with @format_string on @value would
+be valid from a type-compatibility standpoint. @format_string is
+assumed to be a valid format string (from a syntactic standpoint).
+
+If @copy_only is %TRUE then this function additionally checks that it
+would be safe to call g_variant_unref() on @value immediately after
+the call to g_variant_get() without invalidating the result. This is
+only possible if deep copies are made (ie: there are no pointers to
+the data inside of the soon-to-be-freed #GVariant instance). If this
+check fails then a g_critical() is printed and %FALSE is returned.
+
+This function is meant to be used by functions that wish to provide
+varargs accessors to #GVariant values of uncertain values (eg:
+g_variant_lookup() or g_menu_model_get_item_attribute()).
+
+Since: 2.34
+
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a #GVariant
+</parameter_description>
+</parameter>
+<parameter name="format_string">
+<parameter_description> a valid #GVariant format string
+</parameter_description>
+</parameter>
+<parameter name="copy_only">
+<parameter_description> %TRUE to ensure the format string makes deep copies
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @format_string is safe to use
+
+</return>
+</function>
+
<function name="g_variant_classify">
<description>
Classifies @value according to its top-level type.
projects / platform / upstream / glibmm.git / commitdiff