diff options
| author | José Alburquerque <jaalburqu@svn.gnome.org> | 2010-04-11 16:28:38 -0400 |
|---|---|---|
| committer | José Alburquerque <jaalburqu@svn.gnome.org> | 2010-04-11 16:28:38 -0400 |
| commit | f95b190366b7a29cc8956f7c66779a2bc0e18753 (patch) | |
| tree | 03a5a678f44d8339e2dd3fa4bcc2e32627d54535 /gio/src | |
| parent | 98a9f0fa7bbcb264ed577c4d938a46fa89c259a2 (diff) | |
| download | glibmm-f95b190366b7a29cc8956f7c66779a2bc0e18753.tar.gz | |
Regenerate docs with the new docextract_to_xml.py script.
* gio/src/gio_docs.xml:
* glib/src/glib_docs.xml: Regenerated with the new documentation
extraction script to take advantage of the new generation method it
uses.
Diffstat (limited to 'gio/src')
| -rw-r--r-- | gio/src/gio_docs.xml | 7317 |
1 files changed, 3509 insertions, 3808 deletions
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml index 78fad7fe..c3507496 100644 --- a/gio/src/gio_docs.xml +++ b/gio/src/gio_docs.xml @@ -103,6 +103,20 @@ result of the operation. <return></return> </function> +<function name="g_input_stream_clear_pending"> +<description> +Clears the pending flag on @stream. + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> input stream +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_file_attribute_info_list_ref"> <description> References a file attribute info list. @@ -135,37 +149,21 @@ Checks if the file enumerator has been closed. </return> </function> -<function name="g_loadable_icon_load"> +<function name="g_srv_target_get_port"> <description> -Loads a loadable icon. For the asynchronous version of this function, -see g_loadable_icon_load_async(). +Gets @target's port +Since: 2.22 </description> <parameters> -<parameter name="icon"> -<parameter_description> a #GLoadableIcon. -</parameter_description> -</parameter> -<parameter name="size"> -<parameter_description> an integer. -</parameter_description> -</parameter> -<parameter name="type"> -<parameter_description> a location to store the type of the loaded icon, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="target"> +<parameter_description> a #GSrvTarget </parameter_description> </parameter> </parameters> -<return> a #GInputStream to read the icon from. +<return> @target's port + </return> </function> @@ -226,6 +224,22 @@ if possible. <return></return> </function> +<function name="g_io_extension_get_type"> +<description> +Gets the type associated with @extension. + + +</description> +<parameters> +<parameter name="extension"> +<parameter_description> a #GIOExtension +</parameter_description> +</parameter> +</parameters> +<return> the type of @extension +</return> +</function> + <function name="g_drive_is_media_check_automatic"> <description> Checks if @drive is capabable of automatically detecting media changes. @@ -243,6 +257,22 @@ media changes, %FALSE otherwise. </return> </function> +<function name="g_volume_should_automount"> +<description> +Returns whether the volume should be automatically mounted. + + +</description> +<parameters> +<parameter name="volume"> +<parameter_description> a #GVolume +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the volume should be automatically mounted. +</return> +</function> + <function name="g_cancellable_reset"> <description> Resets @cancellable to its uncancelled state. @@ -257,6 +287,43 @@ Resets @cancellable to its uncancelled state. <return></return> </function> +<function name="g_socket_client_connect_to_service_async"> +<description> +This is the asynchronous version of +g_socket_client_connect_to_service(). + +Since: 2.22 + +</description> +<parameters> +<parameter name="client"> +<parameter_description> a #GSocketClient +</parameter_description> +</parameter> +<parameter name="domain"> +<parameter_description> a domain name +</parameter_description> +</parameter> +<parameter name="service"> +<parameter_description> the name of the service to connect to +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data for the callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_unix_mount_monitor_new"> <description> Gets a new #GUnixMountMonitor. The default rate limit for which the @@ -272,32 +339,25 @@ g_unix_mount_monitor_set_rate_limit() to change this. </return> </function> -<function name="g_unix_fd_list_new_from_array"> +<function name="g_app_info_delete"> <description> -Creates a new #GUnixFDList containing the file descriptors given in -@fds. The file descriptors become the property of the new list and -may no longer be used by the caller. The array itself is owned by -the caller. - -Each file descriptor in the array should be set to close-on-exec. +Tries to delete a #GAppInfo. -If @n_fds is -1 then @fds must be terminated with -1. +On some platforms, there may be a difference between user-defined +#GAppInfo<!-- -->s which can be deleted, and system-wide ones which +cannot. See g_app_info_can_delete(). +Since: 2.20 </description> <parameters> -<parameter name="fds"> -<parameter_description> the initial list of file descriptors -</parameter_description> -</parameter> -<parameter name="n_fds"> -<parameter_description> the length of #fds, or -1 +<parameter name="appinfo"> +<parameter_description> a #GAppInfo </parameter_description> </parameter> </parameters> -<return> a new #GUnixFDList +<return> %TRUE if @appinfo has been deleted -Since: 2.24 </return> </function> @@ -308,6 +368,7 @@ service will accept new clients that connect, while a non-active service will let connecting clients queue up until the service is started. +Since: 2.22 </description> <parameters> @@ -318,7 +379,6 @@ up until the service is started. </parameters> <return> %TRUE if the service is active, %FALSE otherwise -Since: 2.22 </return> </function> @@ -363,9 +423,46 @@ Gets the file's size. </return> </function> +<function name="g_resolver_lookup_by_address_async"> +<description> +Begins asynchronously reverse-resolving @address to determine its +associated hostname, and eventually calls @callback, which must +call g_resolver_lookup_by_address_finish() to get the final result. + +Since: 2.22 + +</description> +<parameters> +<parameter name="resolver"> +<parameter_description> a #GResolver +</parameter_description> +</parameter> +<parameter name="address"> +<parameter_description> the address to reverse-resolve +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call after resolution completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data for @callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_control_message_get_level"> <description> -Returns: an integer describing the level +Returns the "level" (i.e. the originating protocol) of the control message. +This is often SOL_SOCKET. + +Since: 2.22 </description> <parameters> @@ -376,24 +473,25 @@ Returns: an integer describing the level </parameters> <return> an integer describing the level -Since: 2.22 </return> </function> -<function name="g_unix_mount_point_guess_can_eject"> +<function name="g_filter_input_stream_set_close_base_stream"> <description> -Guesses whether a Unix mount point can be ejected. - +Sets whether the base stream will be closed when @stream is closed. </description> <parameters> -<parameter name="mount_point"> -<parameter_description> a #GUnixMountPoint +<parameter name="stream"> +<parameter_description> a #GFilterInputStream. +</parameter_description> +</parameter> +<parameter name="close_base"> +<parameter_description> %TRUE to close the base stream. </parameter_description> </parameter> </parameters> -<return> %TRUE if @mount_point is deemed to be ejectable. -</return> +<return></return> </function> <function name="g_file_info_set_attribute"> @@ -422,10 +520,40 @@ Sets the @attribute to contain the given value, if possible. <return></return> </function> +<function name="g_async_initable_new_finish"> +<description> +Finishes the async construction for the various g_async_initable_new calls, +returning the created object or %NULL on error. + +Since: 2.22 + +</description> +<parameters> +<parameter name="initable"> +<parameter_description> the #GAsyncInitable from the callback +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> the #GAsyncResult.from the callback +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. +</parameter_description> +</parameter> +</parameters> +<return> a newly created #GObject, or %NULL on error. Free with +g_object_unref(). + +</return> +</function> + <function name="g_zlib_compressor_new"> <description> Creates a new #GZlibCompressor. +Since: 2.24 </description> <parameters> @@ -440,7 +568,6 @@ Creates a new #GZlibCompressor. </parameters> <return> a new #GZlibCompressor -Since: 2.24 </return> </function> @@ -480,6 +607,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <description> Checks if a stream has pending actions. +Since: 2.22 </description> <parameters> @@ -490,7 +618,6 @@ Checks if a stream has pending actions. </parameters> <return> %TRUE if @stream has pending actions. -Since: 2.22 </return> </function> @@ -615,86 +742,57 @@ Sets the mount operation's domain. <return></return> </function> -<function name="g_content_type_from_mime_type"> +<function name="g_file_info_set_sort_order"> <description> -Tries to find a content type based on the mime type name. - +Sets the sort order attribute in the file info structure. See +%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. </description> <parameters> -<parameter name="mime_type"> -<parameter_description> a mime type string. +<parameter name="info"> +<parameter_description> a #GFileInfo. </parameter_description> </parameter> -</parameters> -<return> Newly allocated string with content type or NULL when does not know. - -Since: 2.18 -</return> -</function> - -<function name="GUnixMountMonitor"> -<description> -Emitted when the unix mount points have changed. - -</description> -<parameters> -<parameter name="monitor"> -<parameter_description> the object on which the signal is emitted +<parameter name="sort_order"> +<parameter_description> a sort order integer. </parameter_description> </parameter> </parameters> <return></return> </function> -<function name="g_socket_listener_new"> -<description> -Creates a new #GSocketListener with no sockets to listen for. -New listeners can be added with e.g. g_socket_listener_add_address() -or g_socket_listener_add_inet_port(). - - -</description> -<parameters> -</parameters> -<return> a new #GSocketListener. - -Since: 2.22 -</return> -</function> - -<function name="g_resolver_lookup_by_address_async"> +<function name="g_loadable_icon_load"> <description> -Begins asynchronously reverse-resolving @address to determine its -associated hostname, and eventually calls @callback, which must -call g_resolver_lookup_by_address_finish() to get the final result. +Loads a loadable icon. For the asynchronous version of this function, +see g_loadable_icon_load_async(). -Since: 2.22 </description> <parameters> -<parameter name="resolver"> -<parameter_description> a #GResolver +<parameter name="icon"> +<parameter_description> a #GLoadableIcon. </parameter_description> </parameter> -<parameter name="address"> -<parameter_description> the address to reverse-resolve +<parameter name="size"> +<parameter_description> an integer. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> a #GCancellable, or %NULL +<parameter name="type"> +<parameter_description> a location to store the type of the loaded icon, %NULL to ignore. </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> callback to call after resolution completes +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> data for @callback +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GInputStream to read the icon from. +</return> </function> <function name="g_volume_enumerate_identifiers"> @@ -732,6 +830,7 @@ is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using g_cancellable_is_cancelled(). +Since: 2.22 </description> <parameters> @@ -750,26 +849,6 @@ g_cancellable_is_cancelled(). </parameters> <return> a newly allocated %GSource, free with g_source_unref(). -Since: 2.22 -</return> -</function> - -<function name="g_inet_address_new_loopback"> -<description> -Creates a #GInetAddress for the loopback address for @family. - - -</description> -<parameters> -<parameter name="family"> -<parameter_description> the address family -</parameter_description> -</parameter> -</parameters> -<return> a new #GInetAddress corresponding to the loopback address -for @family. - -Since: 2.22 </return> </function> @@ -805,55 +884,22 @@ Gets a password from the mount operation. </return> </function> -<function name="g_output_stream_close"> +<function name="g_inet_socket_address_get_address"> <description> -Closes the stream, releasing resources related to it. - -Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. -Closing a stream multiple times will not return an error. - -Closing a stream will automatically flush any outstanding buffers in the -stream. - -Streams will be automatically closed when the last reference -is dropped, but you might want to call this function to make sure -resources are released as early as possible. - -Some streams might keep the backing store of the stream (e.g. a file descriptor) -open after the stream is closed. See the documentation for the individual -stream for details. - -On failure the first error that happened will be reported, but the close -operation will finish as much as possible. A stream that failed to -close will still return %G_IO_ERROR_CLOSED for all operations. Still, it -is important to check and report the error to the user, otherwise -there might be a loss of data as all data might not be written. - -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. -Cancelling a close will still leave the stream closed, but there some streams -can use a faster close that doesn't block to e.g. check errors. On -cancellation (as with any error) there is no guarantee that all written -data will reach the target. +Gets @address's #GInetAddress. +Since: 2.22 </description> <parameters> -<parameter name="stream"> -<parameter_description> A #GOutputStream. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional cancellable object -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter name="address"> +<parameter_description> a #GInetSocketAddress </parameter_description> </parameter> </parameters> -<return> %TRUE on success, %FALSE on failure +<return> the #GInetAddress for @address, which must be +g_object_ref()'d if it will be stored + </return> </function> @@ -1070,22 +1116,6 @@ Creates a new file attribute info list. </return> </function> -<function name="g_unix_mount_guess_should_display"> -<description> -Guesses whether a Unix mount should be displayed in the UI. - - -</description> -<parameters> -<parameter name="mount_entry"> -<parameter_description> a #GUnixMountEntry -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if @mount_entry is deemed to be displayable. -</return> -</function> - <function name="g_async_result_get_user_data"> <description> Gets the user data from a #GAsyncResult. @@ -1098,7 +1128,7 @@ Gets the user data from a #GAsyncResult. </parameter_description> </parameter> </parameters> -<return> the user data for @res. +<return> the user data for @res. </return> </function> @@ -1106,6 +1136,7 @@ Gets the user data from a #GAsyncResult. <description> Sorts @targets in place according to the algorithm in RFC 2782. +Since: 2.22 </description> <parameters> @@ -1116,7 +1147,6 @@ Sorts @targets in place according to the algorithm in RFC 2782. </parameters> <return> the head of the sorted list. -Since: 2.22 </return> </function> @@ -1155,31 +1185,13 @@ Since: 2.22 <return></return> </function> -<function name="g_simple_async_result_set_handle_cancellation"> -<description> -Sets whether to handle cancellation within the asynchronous operation. - - -</description> -<parameters> -<parameter name="simple"> -<parameter_description> a #GSimpleAsyncResult. -</parameter_description> -</parameter> -<parameter name="handle_cancellation"> -<parameter_description> a #gboolean. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_socket_check_connect_result"> <description> Checks and resets the pending connect error for the socket. This is used to check for errors when g_socket_connect() is used in non-blocking mode. +Since: 2.22 </description> <parameters> @@ -1194,7 +1206,6 @@ used in non-blocking mode. </parameters> <return> %TRUE if no error, %FALSE otherwise, setting @error to the error -Since: 2.22 </return> </function> @@ -1239,6 +1250,7 @@ If you are planning to connect to a socket on the resolved IP address, it may be easier to create a #GNetworkAddress and use its #GSocketConnectable interface. +Since: 2.22 </description> <parameters> @@ -1263,7 +1275,6 @@ address, it may be easier to create a #GNetworkAddress and use its must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) -Since: 2.22 </return> </function> @@ -1299,49 +1310,6 @@ Since: 2.22 <return></return> </function> -<function name="g_file_unmount_mountable_with_operation"> -<description> -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. - -Since: 2.22 - -</description> -<parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> flags affecting the operation -</parameter_description> -</parameter> -<parameter name="mount_operation"> -<parameter_description> a #GMountOperation, or %NULL to avoid user interaction. -</parameter_description> -</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, or %NULL. -</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_info_clear_status"> <description> Clears the status information from @info. @@ -1360,6 +1328,7 @@ Clears the status information from @info. <description> Gets @srv's service name (eg, "ldap"). +Since: 2.22 </description> <parameters> @@ -1370,7 +1339,6 @@ Gets @srv's service name (eg, "ldap"). </parameters> <return> @srv's service name -Since: 2.22 </return> </function> @@ -1441,6 +1409,7 @@ If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. +Since: 2.22 </description> <parameters> @@ -1460,7 +1429,6 @@ a value from #GResolverError. If the operation was cancelled, <return> a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. -Since: 2.22 </return> </function> @@ -1505,49 +1473,13 @@ Checks if a file is a backup file. </return> </function> -<function name="g_file_find_enclosing_mount_async"> -<description> -Asynchronously gets the mount for the file. - -For more details, see g_file_find_enclosing_mount() which is -the synchronous version of this call. - -When the operation is finished, @callback will be called. You can then call -g_file_find_enclosing_mount_finish() to get the result of the operation. - -</description> -<parameters> -<parameter name="file"> -<parameter_description> a #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_unix_fd_message_get_fd_list"> <description> Gets the #GUnixFDList contained in @message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of @message. +Since: 2.24 </description> <parameters> @@ -1558,7 +1490,6 @@ the lifetime of @message. </parameters> <return> the #GUnixFDList from @message -Since: 2.24 </return> </function> @@ -1574,6 +1505,7 @@ If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. +Since: 2.22 </description> <parameters> @@ -1597,46 +1529,23 @@ operation, in which case @error (if non-%NULL) will be set to <return> a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. -Since: 2.22 </return> </function> -<function name="g_file_load_contents_async"> +<function name="g_filter_input_stream_get_base_stream"> <description> -Starts an asynchronous load of the @file's contents. - -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 -the @callback. +Gets the base stream for the filter stream. -If @cancellable is not %NULL, then the operation can be cancelled by -triggering the cancellable object from another thread. If the operation -was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<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 name="stream"> +<parameter_description> a #GFilterInputStream. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GInputStream. +</return> </function> <function name="g_file_info_get_file_type"> @@ -1656,32 +1565,6 @@ This is different from the file's content type, see g_file_info_get_content_type </return> </function> -<function name="GFileMonitor"> -<description> -Emitted when a file has been changed. - -</description> -<parameters> -<parameter name="monitor"> -<parameter_description> a #GFileMonitor. -</parameter_description> -</parameter> -<parameter name="file"> -<parameter_description> a #GFile. -</parameter_description> -</parameter> -<parameter name="other_file"> -<parameter_description> a #GFile. -</parameter_description> -</parameter> -<parameter name="event_type"> -<parameter_description> a #GFileMonitorEvent. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_file_info_dup"> <description> Duplicates a file info structure. @@ -1714,24 +1597,27 @@ Checks if a file is a symlink. </return> </function> -<function name="g_inet_address_new_any"> +<function name="g_themed_icon_append_name"> <description> -Creates a #GInetAddress for the "any" address (unassigned/"don't -care") for @family. +Append a name to the list of icons from within @icon. +<note><para> +Note that doing so invalidates the hash computed by prior calls +to g_icon_hash(). +</para></note> </description> <parameters> -<parameter name="family"> -<parameter_description> the address family +<parameter name="icon"> +<parameter_description> a #GThemedIcon +</parameter_description> +</parameter> +<parameter name="iconname"> +<parameter_description> name of icon to append to list of icons from within @icon. </parameter_description> </parameter> </parameters> -<return> a new #GInetAddress corresponding to the "any" address -for @family. - -Since: 2.22 -</return> +<return></return> </function> <function name="g_mount_can_unmount"> @@ -1752,7 +1638,18 @@ Checks if @mount can be mounted. <function name="g_file_replace_readwrite"> <description> -Returns: a #GFileIOStream or %NULL on error. +Returns an output stream for overwriting the file in readwrite mode, +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. + +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 </description> <parameters> @@ -1785,42 +1682,30 @@ current #GFile, or #NULL to ignore <return> a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> -<function name="g_volume_eject_with_operation"> +<function name="g_socket_set_blocking"> <description> -Ejects a volume. This is an asynchronous operation, and is -finished by calling g_volume_eject_with_operation_finish() with the @volume -and #GAsyncResult data returned in the @callback. +Sets the blocking mode of the socket. In blocking mode +all operations block until they succeed or there is an error. In +non-blocking mode all functions return results immediately or +with a %G_IO_ERROR_WOULD_BLOCK error. + +All sockets are created in blocking mode. However, note that the +platform level socket is always non-blocking, and blocking mode +is a GSocket level feature. Since: 2.22 </description> <parameters> -<parameter name="volume"> -<parameter_description> a #GVolume. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> flags affecting the unmount if required for eject -</parameter_description> -</parameter> -<parameter name="mount_operation"> -<parameter_description> a #GMountOperation or %NULL to avoid user interaction. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback, or %NULL. +<parameter name="socket"> +<parameter_description> a #GSocket. </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> user data passed to @callback. +<parameter name="blocking"> +<parameter_description> Whether to use blocking I/O or not. </parameter_description> </parameter> </parameters> @@ -1893,21 +1778,44 @@ Puts a signed 16-bit integer into the output stream. </return> </function> -<function name="g_io_extension_point_lookup"> +<function name="g_socket_client_connect_to_host_async"> <description> -Looks up an existing extension point. +This is the asynchronous version of g_socket_client_connect_to_host(). +When the operation is finished @callback will be +called. You can then call g_socket_client_connect_to_host_finish() to get +the result of the operation. + +Since: 2.22 </description> <parameters> -<parameter name="name"> -<parameter_description> the name of the extension point +<parameter name="client"> +<parameter_description> a #GTcpClient +</parameter_description> +</parameter> +<parameter name="host_and_port"> +<parameter_description> the name and optionally the port of the host to connect to +</parameter_description> +</parameter> +<parameter name="default_port"> +<parameter_description> the default port to connect to +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data for the callback </parameter_description> </parameter> </parameters> -<return> the #GIOExtensionPoint, or %NULL if there is no -registered extension point with the given name -</return> +<return></return> </function> <function name="g_volume_get_identifier"> @@ -1958,6 +1866,7 @@ See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. Checks if graceful disconnects are used. See g_tcp_connection_set_graceful_disconnect(). +Since: 2.22 </description> <parameters> @@ -1968,38 +1877,22 @@ g_tcp_connection_set_graceful_disconnect(). </parameters> <return> %TRUE if graceful disconnect is used on close, %FALSE otherwise -Since: 2.22 </return> </function> -<function name="GDesktopAppInfo"> -<description> -Information about an installed application from a desktop file. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_output_stream_is_closing"> +<function name="g_data_input_stream_get_newline_type"> <description> -Checks if an output stream is being closed. This can be -used inside e.g. a flush implementation to see if the -flush (or other i/o operation) is called from within -the closing operation. +Gets the current newline type for the @stream. </description> <parameters> <parameter name="stream"> -<parameter_description> a #GOutputStream. +<parameter_description> a given #GDataInputStream. </parameter_description> </parameter> </parameters> -<return> %TRUE if @stream is being closed. %FALSE otherwise. - -Since: 2.24 +<return> #GDataStreamNewlineType for the given @stream. </return> </function> @@ -2036,25 +1929,32 @@ or #G_TYPE_INVALID if the extension point has no required type </return> </function> -<function name="g_app_info_delete"> +<function name="g_unix_fd_list_new_from_array"> <description> -Tries to delete a #GAppInfo. +Creates a new #GUnixFDList containing the file descriptors given in +@fds. The file descriptors become the property of the new list and +may no longer be used by the caller. The array itself is owned by +the caller. -On some platforms, there may be a difference between user-defined -#GAppInfo<!-- -->s which can be deleted, and system-wide ones which -cannot. See g_app_info_can_delete(). +Each file descriptor in the array should be set to close-on-exec. +If @n_fds is -1 then @fds must be terminated with -1. + +Since: 2.24 </description> <parameters> -<parameter name="appinfo"> -<parameter_description> a #GAppInfo +<parameter name="fds"> +<parameter_description> the initial list of file descriptors +</parameter_description> +</parameter> +<parameter name="n_fds"> +<parameter_description> the length of #fds, or -1 </parameter_description> </parameter> </parameters> -<return> %TRUE if @appinfo has been deleted +<return> a new #GUnixFDList -Since: 2.20 </return> </function> @@ -2090,24 +1990,23 @@ version of this function, see g_loadable_icon_load(). <return></return> </function> -<function name="g_data_input_stream_set_byte_order"> +<function name="g_socket_control_message_get_size"> <description> -This function sets the byte order for the given @stream. All subsequent -reads from the @stream will be read in the given @order. +Returns the space required for the control message, not including +headers or alignment. +Since: 2.22 </description> <parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. -</parameter_description> -</parameter> -<parameter name="order"> -<parameter_description> a #GDataStreamByteOrder to set. +<parameter name="message"> +<parameter_description> a #GSocketControlMessage </parameter_description> </parameter> </parameters> -<return></return> +<return> The number of bytes required. + +</return> </function> <function name="g_file_set_display_name_finish"> @@ -2136,6 +2035,24 @@ Free the returned object with g_object_unref(). </return> </function> +<function name="g_drive_can_start_degraded"> +<description> +Checks if a drive can be started degraded. + +Since: 2.22 + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the @drive can be started degraded, %FALSE otherwise. + +</return> +</function> + <function name="g_file_info_set_edit_name"> <description> Sets the edit name for the current file. @@ -2159,6 +2076,7 @@ See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. <description> Checks if a drive can be started. +Since: 2.22 </description> <parameters> @@ -2169,44 +2087,52 @@ Checks if a drive can be started. </parameters> <return> %TRUE if the @drive can be started, %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_emblem_get_origin"> +<function name="g_file_info_unset_attribute_mask"> <description> -Gets the origin of the emblem. - +Unsets a mask set by g_file_info_set_attribute_mask(), if one +is set. </description> <parameters> -<parameter name="emblem"> -<parameter_description> a #GEmblem +<parameter name="info"> +<parameter_description> #GFileInfo. </parameter_description> </parameter> </parameters> -<return> the origin of the emblem - -Since: 2.18 -</return> +<return></return> </function> -<function name="g_filter_input_stream_set_close_base_stream"> +<function name="g_app_launch_context_get_startup_notify_id"> <description> -Sets whether the base stream will be closed when @stream is closed. +Initiates startup notification for the application and returns the +DESKTOP_STARTUP_ID for the launched operation, if supported. + +Startup notification IDs are defined in the <ulink +url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"> +FreeDesktop.Org Startup Notifications standard</ulink>. + </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GFilterInputStream. +<parameter name="context"> +<parameter_description> a #GAppLaunchContext </parameter_description> </parameter> -<parameter name="close_base"> -<parameter_description> %TRUE to close the base stream. +<parameter name="info"> +<parameter_description> a #GAppInfo +</parameter_description> +</parameter> +<parameter name="files"> +<parameter_description> a #GList of of #GFile objects </parameter_description> </parameter> </parameters> -<return></return> +<return> a startup notification ID for the application, or %NULL if +not supported. +</return> </function> <function name="g_file_query_info_finish"> @@ -2235,27 +2161,53 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="g_file_attribute_info_list_lookup"> +<function name="g_file_find_enclosing_mount_finish"> <description> -Gets the file attribute with the name @name from @list. +Finishes an asynchronous find mount request. +See g_file_find_enclosing_mount_async(). </description> <parameters> -<parameter name="list"> -<parameter_description> a #GFileAttributeInfoList. +<parameter name="file"> +<parameter_description> a #GFile </parameter_description> </parameter> -<parameter name="name"> -<parameter_description> the name of the attribute to lookup. +<parameter name="res"> +<parameter_description> a #GAsyncResult +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError </parameter_description> </parameter> </parameters> -<return> a #GFileAttributeInfo for the @name, or %NULL if an -attribute isn't found. +<return> #GMount for given @file or %NULL on error. +Free the returned object with g_object_unref(). </return> </function> +<function name="g_unix_output_stream_set_close_fd"> +<description> +Sets whether the file descriptor of @stream shall be closed +when the stream is closed. + +Since: 2.20 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GUnixOutputStream +</parameter_description> +</parameter> +<parameter name="close_fd"> +<parameter_description> %TRUE to close the file descriptor when done +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_file_enumerator_close_finish"> <description> Finishes closing a file enumerator, started from g_file_enumerator_close_async(). @@ -2297,6 +2249,7 @@ Tests whether @address is a site-local address such as 10.0.0.1 not be reached directly from the Internet, but which may have outgoing Internet connectivity via a NAT or firewall). +Since: 2.22 </description> <parameters> @@ -2307,7 +2260,6 @@ outgoing Internet connectivity via a NAT or firewall). </parameters> <return> %TRUE if @address is a site-local address. -Since: 2.22 </return> </function> @@ -2339,85 +2291,21 @@ Sets the application as the default handler for a given type. <description> Checks if abstract unix domain socket names are supported. +Since: 2.22 </description> <parameters> </parameters> <return> %TRUE if supported, %FALSE otherwise -Since: 2.22 </return> </function> -<function name="GCancellable"> -<description> -Emitted when the operation has been cancelled. - -Can be used by implementations of cancellable operations. If the -operation is cancelled from another thread, the signal will be -emitted in the thread that cancelled the operation, not the -thread that is running the operation. - -Note that disconnecting from this signal (or any signal) in a -multi-threaded program is prone to race conditions. For instance -it is possible that a signal handler may be invoked even -<emphasis>after</emphasis> a call to -g_signal_handler_disconnect() for that handler has already -returned. - -There is also a problem when cancellation happen -right before connecting to the signal. If this happens the -signal will unexpectedly not be emitted, and checking before -connecting to the signal leaves a race condition where this is -still happening. - -In order to make it safe and easy to connect handlers there -are two helper functions: g_cancellable_connect() and -g_cancellable_disconnect() which protect against problems -like this. - -An example of how to us this: -|[ -/<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/ -if (g_cancellable_set_error_if_cancelled (cancellable)) -return; - -/<!-- -->* Set up all the data needed to be able to -* handle cancellation of the operation *<!-- -->/ -my_data = my_data_new (...); - -id = 0; -if (cancellable) -id = g_cancellable_connect (cancellable, -G_CALLBACK (cancelled_handler) -data, NULL); - -/<!-- -->* cancellable operation here... *<!-- -->/ - -g_cancellable_disconnect (cancellable, id); - -/<!-- -->* cancelled_handler is never called after this, it -* is now safe to free the data *<!-- -->/ -my_data_free (my_data); -]| - -Note that the cancelled signal is emitted in the thread that -the user cancelled from, which may be the main thread. So, the -cancellable signal should not do something that can block. - -</description> -<parameters> -<parameter name="cancellable"> -<parameter_description> a #GCancellable. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_filter_input_stream_get_close_base_stream"> <description> -Return value: %TRUE if the base stream will be closed. +Returns whether the base stream will be closed when @stream is +closed. + </description> <parameters> @@ -2430,21 +2318,39 @@ Return value: %TRUE if the base stream will be closed. </return> </function> -<function name="g_converter_output_stream_get_converter"> +<function name="g_file_monitor"> <description> -Gets the #GConverter that is used by @converter_stream. +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. + +Since: 2.18 </description> <parameters> -<parameter name="converter_stream"> -<parameter_description> a #GConverterOutputStream +<parameter name="file"> +<parameter_description> input #GFile +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a set of #GFileMonitorFlags +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> the converter of the converter output stream +<return> a #GFileMonitor for the given @file, or %NULL on error. +Free the returned object with g_object_unref(). -Since: 2.24 </return> </function> @@ -2503,48 +2409,16 @@ of the request. <return></return> </function> -<function name="g_file_create_readwrite_async"> +<function name="g_memory_input_stream_new"> <description> -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. +Creates a new empty #GMemoryInputStream. -Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> a set of #GFileCreateFlags -</parameter_description> -</parameter> -<parameter name="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> +<return> a new #GInputStream +</return> </function> <function name="g_resolver_free_targets"> @@ -2575,6 +2449,7 @@ If your application or library provides one or more #GIcon implementations you need to ensure that each #GType is registered with the type system prior to calling g_icon_new_for_string(). +Since: 2.20 </description> <parameters> @@ -2590,7 +2465,6 @@ with the type system prior to calling g_icon_new_for_string(). <return> An object implementing the #GIcon interface or %NULL if @error is set. -Since: 2.20 </return> </function> @@ -2633,6 +2507,7 @@ Only the first call initializes the object, further calls return the result of the first call. This is so that its safe to implement the singleton pattern in the GObject constructor function. +Since: 2.22 </description> <parameters> @@ -2653,7 +2528,6 @@ ignore. <return> %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. -Since: 2.22 </return> </function> @@ -2695,6 +2569,23 @@ its elements have been unreffed with g_object_unref(). </return> </function> +<function name="g_io_extension_ref_class"> +<description> +Gets a reference to the class for the type that is +associated with @extension. + + +</description> +<parameters> +<parameter name="extension"> +<parameter_description> a #GIOExtension +</parameter_description> +</parameter> +</parameters> +<return> the #GTypeClass for the type of @extension +</return> +</function> + <function name="g_memory_input_stream_new_from_data"> <description> Creates a new #GMemoryInputStream with data in memory of a given size. @@ -2723,6 +2614,7 @@ Creates a new #GMemoryInputStream with data in memory of a given size. <description> Creates a new #GDesktopAppInfo. +Since: 2.18 </description> <parameters> @@ -2733,7 +2625,6 @@ Creates a new #GDesktopAppInfo. </parameters> <return> a new #GDesktopAppInfo or %NULL on error. -Since: 2.18 </return> </function> @@ -2759,6 +2650,7 @@ Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs. +Since: 2.22 </description> <parameters> @@ -2769,7 +2661,6 @@ not supported by the #GSocketConnection APIs. </parameters> <return> a #GSocketAddress or %NULL on error. -Since: 2.22 </return> </function> @@ -2821,24 +2712,6 @@ Check if @drive has any mountable volumes. </return> </function> -<function name="g_utf8_input_stream_new"> -<description> -Creates a new #GUtf8InputStream from the given @base_stream. - - -</description> -<parameters> -<parameter name="base_stream"> -<parameter_description> a #GInputStream. -</parameter_description> -</parameter> -</parameters> -<return> a #GInputStream for the given @base_stream. - -Since: 2.24 -</return> -</function> - <function name="g_app_info_get_description"> <description> Gets a human-readable description of an installed application. @@ -2876,6 +2749,19 @@ Checks if two #GAppInfo<!-- -->s are equal. </return> </function> +<function name="g_cancellable_get_current"> +<description> +Gets the top cancellable from the stack. + + +</description> +<parameters> +</parameters> +<return> a #GCancellable from the top of the stack, or %NULL +if the stack is empty. +</return> +</function> + <function name="g_mount_remount"> <description> Remounts a mount. This is an asynchronous operation, and is @@ -2934,81 +2820,58 @@ Checks if an output stream has already been closed. </return> </function> -<function name="g_socket_listener_add_address"> +<function name="g_inet_address_to_bytes"> <description> -Creates a socket of type @type and protocol @protocol, binds -it to @address and adds it to the set of sockets we're accepting -sockets from. - -Note that adding an IPv6 address, depending on the platform, -may or may not result in a listener that also accepts IPv4 -connections. For more determinstic behaviour, see -g_socket_listener_add_inet_port(). - -@source_object will be passed out in the various calls -to accept to identify this particular source, which is -useful if you're listening on multiple addresses and do -different things depending on what address is connected to. - -If successful and @effective_address is non-%NULL then it will -be set to the address that the binding actually occured at. This -is helpful for determining the port number that was used for when -requesting a binding to port 0 (ie: "any port"). This address, if -requested, belongs to the caller and must be freed. +Gets the raw binary address data from @address. +Since: 2.22 </description> <parameters> -<parameter name="listener"> -<parameter_description> a #GSocketListener -</parameter_description> -</parameter> <parameter name="address"> -<parameter_description> a #GSocketAddress -</parameter_description> -</parameter> -<parameter name="type"> -<parameter_description> a #GSocketType -</parameter_description> -</parameter> -<parameter name="protocol"> -<parameter_description> a #GSocketProtocol -</parameter_description> -</parameter> -<parameter name="source_object"> -<parameter_description> Optional #GObject identifying this source -</parameter_description> -</parameter> -<parameter name="effective_address"> -<parameter_description> location to store the address that was bound to, or %NULL. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting, or %NULL to ignore. +<parameter_description> a #GInetAddress </parameter_description> </parameter> </parameters> -<return> %TRUE on success, %FALSE on error. +<return> a pointer to an internal array of the bytes in @address, +which should not be modified, stored, or freed. The size of this +array can be gotten with g_inet_address_get_native_size(). -Since: 2.22 </return> </function> -<function name="g_vfs_get_supported_uri_schemes"> +<function name="g_file_attribute_info_list_unref"> <description> -Gets a list of URI schemes supported by @vfs. +Removes a reference from the given @list. If the reference count +falls to zero, the @list is deleted. + +</description> +<parameters> +<parameter name="list"> +<parameter_description> The #GFileAttributeInfoList to unreference. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_file_get_path"> +<description> +Gets the local pathname for #GFile, if one exists. + +This call does no blocking i/o. </description> <parameters> -<parameter name="vfs"> -<parameter_description> a #GVfs. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> </parameters> -<return> a %NULL-terminated array of strings. -The returned array belongs to GIO and must -not be freed or modified. +<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> @@ -3117,6 +2980,24 @@ Gets the source tag for the #GSimpleAsyncResult. </return> </function> +<function name="g_file_descriptor_based_get_fd"> +<description> +Gets the underlying file descriptor. + +Since: 2.24 + +</description> +<parameters> +<parameter name="fd_based"> +<parameter_description> a #GFileDescriptorBased. +</parameter_description> +</parameter> +</parameters> +<return> The file descriptor + +</return> +</function> + <function name="g_file_append_to"> <description> Gets an output stream for appending data to the file. If @@ -3221,6 +3102,7 @@ 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. +Since: 2.18 </description> <parameters> @@ -3240,13 +3122,15 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <return> %TRUE if all directories have been successfully created, %FALSE otherwise. -Since: 2.18 </return> </function> <function name="g_buffered_input_stream_peek_buffer"> <description> -Returns: read-only buffer +Returns the buffer with the currently available bytes. The returned +buffer must not be modified and will become invalid when reading from +the stream or filling the buffer. + </description> <parameters> @@ -3263,23 +3147,6 @@ Returns: read-only buffer </return> </function> -<function name="GDrive"> -<description> -Emitted when the physical stop button (if any) of a drive has -been pressed. - -Since: 2.22 - -</description> -<parameters> -<parameter name="drive"> -<parameter_description> a #GDrive. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_file_mount_enclosing_volume_finish"> <description> Finishes a mount operation started by g_file_mount_enclosing_volume(). @@ -3311,6 +3178,7 @@ appropriately if present. Creates a new #GThreadedSocketService with no listeners. Listeners must be added with g_socket_service_add_listeners(). +Since: 2.22 </description> <parameters> @@ -3322,7 +3190,6 @@ handling incoming clients, -1 means no limit </parameters> <return> a new #GSocketService. -Since: 2.22 </return> </function> @@ -3349,44 +3216,46 @@ ignore. </return> </function> -<function name="g_resolver_lookup_service_async"> +<function name="g_data_input_stream_read_until_async"> <description> -Begins asynchronously performing a DNS SRV lookup for the given -@service and @protocol in the given @domain, and eventually calls -@callback, which must call g_resolver_lookup_service_finish() to -get the final result. See g_resolver_lookup_service() for more -details. +The asynchronous version of g_data_input_stream_read_until(). +It is an error to have two outstanding calls to this function. -Since: 2.22 +Note that, in contrast to g_data_input_stream_read_until(), +this function does not consume the stop character that it finds. You +must read it for yourself. + +When the operation is finished, @callback will be called. You +can then call g_data_input_stream_read_until_finish() to get +the result of the operation. + +Since: 2.20 </description> <parameters> -<parameter name="resolver"> -<parameter_description> a #GResolver -</parameter_description> -</parameter> -<parameter name="service"> -<parameter_description> the service type to look up (eg, "ldap") +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. </parameter_description> </parameter> -<parameter name="protocol"> -<parameter_description> the networking protocol to use for @service (eg, "tcp") +<parameter name="stop_chars"> +<parameter_description> characters to terminate the read. </parameter_description> </parameter> -<parameter name="domain"> -<parameter_description> the DNS domain to look up the service in +<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> a #GCancellable, or %NULL +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> callback to call after resolution completes +<parameter_description> callback to call when the request is satisfied. </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> data for @callback +<parameter_description> the data to pass to callback function. </parameter_description> </parameter> </parameters> @@ -3431,40 +3300,6 @@ more addresses. </return> </function> -<function name="g_io_scheduler_job_send_to_mainloop_async"> -<description> -Used from an I/O job to send a callback to be run asynchronously in -the thread that the job was started from. The callback will be run -when the main loop is available, but at that time the I/O job might -have finished. The return value from the callback is ignored. - -Note that if you are passing the @user_data from g_io_scheduler_push_job() -on to this function you have to ensure that it is not freed before -@func is called, either by passing %NULL as @notify to -g_io_scheduler_push_job() or by using refcounting for @user_data. - -</description> -<parameters> -<parameter name="job"> -<parameter_description> a #GIOSchedulerJob -</parameter_description> -</parameter> -<parameter name="func"> -<parameter_description> a #GSourceFunc callback that will be called in the original thread -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> data to pass to @func -</parameter_description> -</parameter> -<parameter name="notify"> -<parameter_description> a #GDestroyNotify for @user_data, or %NULL -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_file_monitor_cancel"> <description> Cancels a file monitor. @@ -3536,6 +3371,7 @@ You are not supposed to read from the fd yourself, just check for readable status. Reading to unset the readable status is done with g_cancellable_reset(). +Since: 2.22 </description> <parameters> @@ -3551,7 +3387,6 @@ with g_cancellable_reset(). <return> %TRUE if @pollfd was successfully initialized, %FALSE on failure to prepare the cancellable. -Since: 2.22 </return> </function> @@ -3594,32 +3429,28 @@ when the stream is closed. </return> </function> -<function name="GSocketService"> +<function name="g_file_input_stream_query_info_finish"> <description> -The ::incoming signal is emitted when a new incoming connection -to @service needs to be handled. The handler must initiate the -handling of @connection, but may not block; in essence, -asynchronous operations must be used. +Finishes an asynchronous info query operation. </description> <parameters> -<parameter name="service"> -<parameter_description> the #GSocketService. +<parameter name="stream"> +<parameter_description> a #GFileInputStream. </parameter_description> </parameter> -<parameter name="connection"> -<parameter_description> a new #GSocketConnection object. +<parameter name="result"> +<parameter_description> a #GAsyncResult. </parameter_description> </parameter> -<parameter name="source_object"> -<parameter_description> the source_object passed to g_socket_listener_add_address(). +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, +or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> %TRUE to stop other handlers from being called - -Since: 2.22 +<return> #GFileInfo. </return> </function> @@ -3628,6 +3459,7 @@ Since: 2.22 Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. +Since: 2.22 </description> <parameters> @@ -3647,49 +3479,22 @@ ignore. </parameters> <return> %TRUE if the mount was successfully unmounted. %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_app_info_launch"> +<function name="g_mount_operation_get_password_save"> <description> -Launches the application. Passes @files to the launched application -as arguments, using the optional @launch_context to get information -about the details of the launcher (like what screen it is on). -On error, @error will be set accordingly. - -To lauch the application without arguments pass a %NULL @files list. - -Note that even if the launch is successful the application launched -can fail to start if it runs into problems during startup. There is -no way to detect this. - -Some URIs can be changed when passed through a GFile (for instance -unsupported uris with strange formats like mailto:), so if you have -a textual uri you want to pass in as argument, consider using -g_app_info_launch_uris() instead. +Gets the state of saving passwords for the mount operation. </description> <parameters> -<parameter name="appinfo"> -<parameter_description> a #GAppInfo -</parameter_description> -</parameter> -<parameter name="files"> -<parameter_description> a #GList of #GFile objects -</parameter_description> -</parameter> -<parameter name="launch_context"> -<parameter_description> a #GAppLaunchContext or %NULL -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError +<parameter name="op"> +<parameter_description> a #GMountOperation. </parameter_description> </parameter> </parameters> -<return> %TRUE on successful launch, %FALSE otherwise. +<return> a #GPasswordSave flag. </return> </function> @@ -3759,31 +3564,6 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </return> </function> -<function name="g_file_input_stream_query_info_finish"> -<description> -Finishes an asynchronous info query operation. - - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a #GFileInputStream. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, -or %NULL to ignore. -</parameter_description> -</parameter> -</parameters> -<return> #GFileInfo. -</return> -</function> - <function name="g_seekable_seek"> <description> Seeks in the stream by the given @offset, modified by @type. @@ -3860,27 +3640,74 @@ given name, or %NULL if there is no extension with that name </return> </function> -<function name="g_data_input_stream_get_newline_type"> +<function name="g_inet_address_get_family"> <description> -Gets the current newline type for the @stream. +Gets @address's family +Since: 2.22 </description> <parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. +<parameter name="address"> +<parameter_description> a #GInetAddress </parameter_description> </parameter> </parameters> -<return> #GDataStreamNewlineType for the given @stream. +<return> @address's family + </return> </function> +<function name="g_resolver_lookup_service_async"> +<description> +Begins asynchronously performing a DNS SRV lookup for the given +@service and @protocol in the given @domain, and eventually calls +@callback, which must call g_resolver_lookup_service_finish() to +get the final result. See g_resolver_lookup_service() for more +details. + +Since: 2.22 + +</description> +<parameters> +<parameter name="resolver"> +<parameter_description> a #GResolver +</parameter_description> +</parameter> +<parameter name="service"> +<parameter_description> the service type to look up (eg, "ldap") +</parameter_description> +</parameter> +<parameter name="protocol"> +<parameter_description> the networking protocol to use for @service (eg, "tcp") +</parameter_description> +</parameter> +<parameter name="domain"> +<parameter_description> the DNS domain to look up the service in +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call after resolution completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data for @callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_volume_eject_with_operation_finish"> <description> Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. +Since: 2.22 </description> <parameters> @@ -3900,7 +3727,24 @@ ignore. </parameters> <return> %TRUE if the volume was successfully ejected. %FALSE otherwise. -Since: 2.22 +</return> +</function> + +<function name="g_converter_output_stream_get_converter"> +<description> +Gets the #GConverter that is used by @converter_stream. + +Since: 2.24 + +</description> +<parameters> +<parameter name="converter_stream"> +<parameter_description> a #GConverterOutputStream +</parameter_description> +</parameter> +</parameters> +<return> the converter of the converter output stream + </return> </function> @@ -3984,16 +3828,48 @@ ignore. </return> </function> -<function name="g_memory_input_stream_new"> +<function name="g_file_create_readwrite_async"> <description> -Creates a new empty #GMemoryInputStream. +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. + +Since: 2.22 </description> <parameters> +<parameter name="file"> +<parameter_description> input #GFile +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a set of #GFileCreateFlags +</parameter_description> +</parameter> +<parameter name="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> a new #GInputStream -</return> +<return></return> </function> <function name="g_socket_address_to_native"> @@ -4006,6 +3882,7 @@ If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. +Since: 2.22 </description> <parameters> @@ -4030,7 +3907,6 @@ g_socket_address_get_native_size(). </parameters> <return> %TRUE if @dest was filled in, %FALSE on error -Since: 2.22 </return> </function> @@ -4071,6 +3947,7 @@ g_socket_client_set_socket_type(). If a local address is specified with g_socket_client_set_local_address() the socket will be bound to this address before connecting. +Since: 2.22 </description> <parameters> @@ -4093,7 +3970,6 @@ socket will be bound to this address before connecting. </parameters> <return> a #GSocketConnection on success, %NULL on error. -Since: 2.22 </return> </function> @@ -4131,6 +4007,7 @@ Gets the protocol name type of the socket client. See g_socket_client_set_protocol() for details. +Since: 2.22 </description> <parameters> @@ -4141,7 +4018,40 @@ See g_socket_client_set_protocol() for details. </parameters> <return> a #GSocketProtocol +</return> +</function> + +<function name="g_unix_mount_point_guess_can_eject"> +<description> +Guesses whether a Unix mount point can be ejected. + + +</description> +<parameters> +<parameter name="mount_point"> +<parameter_description> a #GUnixMountPoint +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @mount_point is deemed to be ejectable. +</return> +</function> + +<function name="g_io_stream_is_closed"> +<description> +Checks if a stream is closed. + Since: 2.22 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GIOStream +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the stream is closed. + </return> </function> @@ -4169,31 +4079,56 @@ Since: 2.22 <return></return> </function> -<function name="GZlibDecompressor"> +<function name="g_network_service_new"> <description> -Zlib decompression +Creates a new #GNetworkService representing the given @service, +@protocol, and @domain. This will initially be unresolved; use the +#GSocketConnectable interface to resolve it. + +Since: 2.22 </description> <parameters> +<parameter name="service"> +<parameter_description> the service type to look up (eg, "ldap") +</parameter_description> +</parameter> +<parameter name="protocol"> +<parameter_description> the networking protocol to use for @service (eg, "tcp") +</parameter_description> +</parameter> +<parameter name="domain"> +<parameter_description> the DNS domain to look up the service in +</parameter_description> +</parameter> </parameters> -<return></return> +<return> a new #GNetworkService + +</return> </function> -<function name="g_inet_address_get_family"> +<function name="g_data_input_stream_read_byte"> <description> -Gets @address's family +Reads an unsigned 8-bit/1-byte value from @stream. </description> <parameters> -<parameter name="address"> -<parameter_description> a #GInetAddress +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting. </parameter_description> </parameter> </parameters> -<return> @address's family - -Since: 2.22 +<return> an unsigned 8-bit/1-byte value read from the @stream or %0 +if an error occurred. </return> </function> @@ -4227,6 +4162,7 @@ described in the <ulink url="http://standards.freedesktop.org/menu-spec/ <description> Finishes an async connect operation. See g_socket_client_connect_to_host_async() +Since: 2.22 </description> <parameters> @@ -4246,17 +4182,39 @@ ignore. </parameters> <return> a #GSocketConnection on success, %NULL on error. -Since: 2.22 </return> </function> -<function name="GNetworkAddress"> +<function name="g_io_scheduler_job_send_to_mainloop_async"> <description> -A #GSocketConnectable for resolving a hostname and connecting to -that host. +Used from an I/O job to send a callback to be run asynchronously in +the thread that the job was started from. The callback will be run +when the main loop is available, but at that time the I/O job might +have finished. The return value from the callback is ignored. + +Note that if you are passing the @user_data from g_io_scheduler_push_job() +on to this function you have to ensure that it is not freed before +@func is called, either by passing %NULL as @notify to +g_io_scheduler_push_job() or by using refcounting for @user_data. </description> <parameters> +<parameter name="job"> +<parameter_description> a #GIOSchedulerJob +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> a #GSourceFunc callback that will be called in the original thread +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data to pass to @func +</parameter_description> +</parameter> +<parameter name="notify"> +<parameter_description> a #GDestroyNotify for @user_data, or %NULL +</parameter_description> +</parameter> </parameters> <return></return> </function> @@ -4282,60 +4240,65 @@ This array must be freed by g_strfreev() when finished. </return> </function> -<function name="g_mount_is_shadowed"> +<function name="g_file_load_partial_contents_finish"> <description> -Determines if @mount is shadowed. Applications or libraries should -avoid displaying @mount in the user interface if it is shadowed. - -A mount is said to be shadowed if there exists one or more user -visible objects (currently #GMount objects) with a root that is -inside the root of @mount. - -One application of shadow mounts is when exposing a single file -system that is used to address several logical volumes. In this -situation, a #GVolumeMonitor implementation would create two -#GVolume objects (for example, one for the camera functionality of -the device and one for a SD card reader on the device) with -activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal> -and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the -underlying mount (with root -<literal>gphoto2://[usb:001,002]/</literal>) is mounted, said -#GVolumeMonitor implementation would create two #GMount objects -(each with their root matching the corresponding volume activation -root) that would shadow the original mount. - -The proxy monitor in GVfs 2.26 and later, automatically creates and -manage shadow mounts (and shadows the underlying mount) if the -activation root on a #GVolume is set. +Finishes an asynchronous partial load operation that was started +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="mount"> -<parameter_description> A #GMount. +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="contents"> +<parameter_description> a location to place the contents of the file. +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> a location to place the length of the contents of the file, +or %NULL if the length is not needed +</parameter_description> +</parameter> +<parameter name="etag_out"> +<parameter_description> a location to place the current entity tag for the file, +or %NULL if the entity tag is not needed +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> %TRUE if @mount is shadowed. - -Since: 2.20 +<return> %TRUE if the load was successful. If %FALSE and @error is +present, it will be set appropriately. </return> </function> -<function name="g_file_info_get_icon"> +<function name="g_simple_async_result_set_from_error"> <description> -Gets the icon for a file. - +Sets the result from a #GError. </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="simple"> +<parameter_description> a #GSimpleAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError. </parameter_description> </parameter> </parameters> -<return> #GIcon for the given @info. -</return> +<return></return> </function> <function name="g_filter_output_stream_set_close_base_stream"> @@ -4356,46 +4319,43 @@ Sets whether the base stream will be closed when @stream is closed. <return></return> </function> -<function name="g_file_set_display_name"> +<function name="g_mount_is_shadowed"> <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. +Determines if @mount is shadowed. Applications or libraries should +avoid displaying @mount in the user interface if it is shadowed. -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(). +A mount is said to be shadowed if there exists one or more user +visible objects (currently #GMount objects) with a root that is +inside the root of @mount. -On success the resulting converted filename is returned. +One application of shadow mounts is when exposing a single file +system that is used to address several logical volumes. In this +situation, a #GVolumeMonitor implementation would create two +#GVolume objects (for example, one for the camera functionality of +the device and one for a SD card reader on the device) with +activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal> +and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the +underlying mount (with root +<literal>gphoto2://[usb:001,002]/</literal>) is mounted, said +#GVolumeMonitor implementation would create two #GMount objects +(each with their root matching the corresponding volume activation +root) that would shadow the original mount. -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 proxy monitor in GVfs 2.26 and later, automatically creates and +manage shadow mounts (and shadows the underlying mount) if the +activation root on a #GVolume is set. +Since: 2.20 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="display_name"> -<parameter_description> a string. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="mount"> +<parameter_description> A #GMount. </parameter_description> </parameter> </parameters> -<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> %TRUE if @mount is shadowed. + </return> </function> @@ -4451,56 +4411,6 @@ an error occurred. </return> </function> -<function name="g_output_stream_write"> -<description> -Tries to write @count bytes from @buffer into the stream. Will block -during the operation. - -If count is zero returns zero and does nothing. A value of @count -larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. - -On success, the number of bytes written to the stream is returned. -It is not an error if this is not the same as the requested size, as it -can happen e.g. on a partial i/o error, or if there is not enough -storage in the stream. All writes either block until at least one byte -is written, so zero is never returned (unless @count is zero). - -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 an -operation was partially finished when the operation was cancelled the -partial result will be returned, without an error. - -On error -1 is returned and @error is set accordingly. - - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a #GOutputStream. -</parameter_description> -</parameter> -<parameter name="buffer"> -<parameter_description> the buffer containing the data to write. -</parameter_description> -</parameter> -<parameter name="count"> -<parameter_description> the number of bytes to write -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional cancellable object -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore -</parameter_description> -</parameter> -</parameters> -<return> Number of bytes written, or -1 on error -</return> -</function> - <function name="g_socket_client_set_socket_type"> <description> Sets the socket type of the socket client. @@ -4526,33 +4436,22 @@ Since: 2.22 <return></return> </function> -<function name="g_file_poll_mountable_finish"> +<function name="g_volume_monitor_get_connected_drives"> <description> -Finishes a poll operation. See g_file_poll_mountable() for details. +Gets a list of drives connected to the system. -Finish an asynchronous poll operation that was polled -with g_file_poll_mountable(). +The returned list should be freed with g_list_free(), after +its elements have been unreffed with g_object_unref(). </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="volume_monitor"> +<parameter_description> a #GVolumeMonitor. </parameter_description> </parameter> </parameters> -<return> %TRUE if the operation finished successfully. %FALSE -otherwise. - -Since: 2.22 +<return> a #GList of connected #GDrive objects. </return> </function> @@ -4582,22 +4481,20 @@ ignore. </return> </function> -<function name="g_simple_async_result_set_from_error"> +<function name="g_file_info_get_icon"> <description> -Sets the result from a #GError. +Gets the icon for a file. + </description> <parameters> -<parameter name="simple"> -<parameter_description> a #GSimpleAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError. +<parameter name="info"> +<parameter_description> a #GFileInfo. </parameter_description> </parameter> </parameters> -<return></return> +<return> #GIcon for the given @info. +</return> </function> <function name="g_file_new_for_commandline_arg"> @@ -4620,64 +4517,15 @@ I/O operation if @arg points to a malformed path. </return> </function> -<function name="g_data_input_stream_read_until_async"> -<description> -The asynchronous version of g_data_input_stream_read_until(). -It is an error to have two outstanding calls to this function. - -When the operation is finished, @callback will be called. You -can then call g_data_input_stream_read_until_finish() to get -the result of the operation. - -Since: 2.20 - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. -</parameter_description> -</parameter> -<parameter name="stop_chars"> -<parameter_description> characters to terminate the read. -</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> callback 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_io_stream_get_output_stream"> +<function name="g_io_error_quark"> <description> -Gets the output stream for this object. This is used for -writing. +Gets the GIO Error Quark. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GIOStream -</parameter_description> -</parameter> </parameters> -<return> a #GOutputStream, owned by the #GIOStream. Do not free. - -Since: 2.22 +<return> a #GQuark. </return> </function> @@ -4700,74 +4548,29 @@ All implementations must henceforth have this type. <return></return> </function> -<function name="g_network_service_get_domain"> -<description> -Gets the domain that @srv serves. This might be either UTF-8 or -ASCII-encoded, depending on what @srv was created with. - - -</description> -<parameters> -<parameter name="srv"> -<parameter_description> a #GNetworkService -</parameter_description> -</parameter> -</parameters> -<return> @srv's domain name - -Since: 2.22 -</return> -</function> - -<function name="GVolume"> +<function name="g_file_query_settable_attributes"> <description> -This signal is emitted when the #GVolume have been removed. If -the recipient is holding references to the object they should -release them so the object can be finalized. +Obtain the list of settable attributes for the file. -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_socket_address_enumerator_next_async"> -<description> -Asynchronously retrieves the next #GSocketAddress from @enumerator -and then calls @callback, which must call -g_socket_address_enumerator_next_finish() to get the result. </description> <parameters> -<parameter name="enumerator"> -<parameter_description> a #GSocketAddressEnumerator +<parameter name="file"> +<parameter_description> input #GFile. </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 name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return></return> -</function> - -<function name="GDataOutputStream"> -<description> -Determines the byte ordering that is used when writing -multi-byte entities (such as integers) to the stream. - -</description> -<parameters> -</parameters> -<return></return> +<return> a #GFileAttributeInfoList describing the settable attributes. +When you are done with it, release it with g_file_attribute_info_list_unref() +</return> </function> <function name="g_converter_reset"> @@ -4788,22 +4591,23 @@ Since: 2.24 <return></return> </function> -<function name="g_volume_monitor_get_mounts"> +<function name="g_buffered_output_stream_new_sized"> <description> -Gets a list of the mounts on the system. - -The returned list should be freed with g_list_free(), after -its elements have been unreffed with g_object_unref(). +Creates a new buffered output stream with a given buffer size. </description> <parameters> -<parameter name="volume_monitor"> -<parameter_description> a #GVolumeMonitor. +<parameter name="base_stream"> +<parameter_description> a #GOutputStream. +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> a #gsize. </parameter_description> </parameter> </parameters> -<return> a #GList of #GMount objects. +<return> a #GOutputStream with an internal buffer set to @size. </return> </function> @@ -4812,6 +4616,7 @@ its elements have been unreffed with g_object_unref(). Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned. +Since: 2.22 </description> <parameters> @@ -4822,7 +4627,6 @@ In case the protocol is unknown, -1 is returned. </parameters> <return> a protocol id, or -1 if unknown -Since: 2.22 </return> </function> @@ -4873,12 +4677,22 @@ of the request. <return></return> </function> -<function name="g_file_mount_mountable_finish"> +<function name="g_file_set_display_name"> <description> -Finishes a mount operation. See g_file_mount_mountable() for details. +Renames @file to the specified display name. -Finish an asynchronous mount operation that was started -with g_file_mount_mountable(). +The display name is converted from UTF8 to the correct encoding for the target +filesystem if possible and the @file is renamed to this. + +If you want to implement a rename operation in the user interface the edit name +(#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename +widget, and then the result after editing should be passed to g_file_set_display_name(). + +On success the resulting converted filename is returned. + +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> @@ -4887,8 +4701,12 @@ with g_file_mount_mountable(). <parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. +<parameter name="display_name"> +<parameter_description> a string. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> <parameter name="error"> @@ -4896,7 +4714,8 @@ with g_file_mount_mountable(). </parameter_description> </parameter> </parameters> -<return> a #GFile or %NULL on 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> @@ -4925,23 +4744,20 @@ Removes a supported type from an application, if possible. </return> </function> -<function name="g_file_info_set_sort_order"> +<function name="g_socket_listener_new"> <description> -Sets the sort order attribute in the file info structure. See -%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. +Creates a new #GSocketListener with no sockets to listen for. +New listeners can be added with e.g. g_socket_listener_add_address() +or g_socket_listener_add_inet_port(). + +Since: 2.22 </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. -</parameter_description> -</parameter> -<parameter name="sort_order"> -<parameter_description> a sort order integer. -</parameter_description> -</parameter> </parameters> -<return></return> +<return> a new #GSocketListener. + +</return> </function> <function name="g_socket_listener_set_backlog"> @@ -5010,6 +4826,7 @@ Helper function for constructing #GInitiable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. +Since: 2.22 </description> <parameters> @@ -5037,7 +4854,6 @@ ignore. </parameters> <return> a newly allocated #GObject, or %NULL on error -Since: 2.22 </return> </function> @@ -5045,6 +4861,7 @@ Since: 2.22 <description> Creates a new #GCharsetConverter. +Since: 2.24 </description> <parameters> @@ -5063,7 +4880,6 @@ Creates a new #GCharsetConverter. </parameters> <return> a new #GCharsetConverter or %NULL on error. -Since: 2.24 </return> </function> @@ -5083,9 +4899,43 @@ Creates a new data input stream for the @base_stream. </return> </function> +<function name="g_socket_listener_accept_finish"> +<description> +Finishes an async accept operation. See g_socket_listener_accept_async() + +Since: 2.22 + +</description> +<parameters> +<parameter name="listener"> +<parameter_description> a #GSocketListener +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="source_object"> +<parameter_description> Optional #GObject identifying this source +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. +</parameter_description> +</parameter> +</parameters> +<return> a #GSocketConnection on success, %NULL on error. + +</return> +</function> + <function name="g_unix_output_stream_get_close_fd"> <description> -Return value: %TRUE if the file descriptor is closed when done +Returns whether the file descriptor of @stream will be +closed when the stream is closed. + +Since: 2.20 </description> <parameters> @@ -5096,7 +4946,6 @@ Return value: %TRUE if the file descriptor is closed when done </parameters> <return> %TRUE if the file descriptor is closed when done -Since: 2.20 </return> </function> @@ -5145,6 +4994,7 @@ Sets the operation result to a boolean within the asynchronous result. <description> Creates a new #GInetSocketAddress for @address and @port. +Since: 2.22 </description> <parameters> @@ -5159,7 +5009,6 @@ Creates a new #GInetSocketAddress for @address and @port. </parameters> <return> a new #GInetSocketAddress -Since: 2.22 </return> </function> @@ -5198,6 +5047,7 @@ Gets @target's weight. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. +Since: 2.22 </description> <parameters> @@ -5208,7 +5058,6 @@ RFC 2782. </parameters> <return> @target's weight -Since: 2.22 </return> </function> @@ -5227,6 +5076,7 @@ when you are done. A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. +Since: 2.24 </description> <parameters> @@ -5245,7 +5095,6 @@ system-wide file descriptor limit. </parameters> <return> the file descriptor, or -1 in case of error -Since: 2.24 </return> </function> @@ -5279,6 +5128,7 @@ g_socket_bind(). To set the maximum amount of outstanding clients, use g_socket_set_listen_backlog(). +Since: 2.22 </description> <parameters> @@ -5293,7 +5143,6 @@ g_socket_set_listen_backlog(). </parameters> <return> %TRUE on success, %FALSE on error. -Since: 2.22 </return> </function> @@ -5303,6 +5152,7 @@ Helper function for constructing #GInitiable object. This is similar to g_object_new() but also initializes the object and returns %NULL, setting an error on failure. +Since: 2.22 </description> <parameters> @@ -5332,39 +5182,25 @@ value pairs, and ended by %NULL. </parameters> <return> a newly allocated #GObject, or %NULL on error -Since: 2.22 </return> </function> -<function name="g_file_query_writable_namespaces"> +<function name="g_mount_operation_set_anonymous"> <description> -Obtain the list of attribute namespaces where new attributes -can be created by a user. An example of this is extended -attributes (in the "xattr" namespace). - -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. - +Sets the mount operation to use an anonymous user if @anonymous is %TRUE. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="op"> +<parameter_description> a #GMountOperation. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="anonymous"> +<parameter_description> boolean value. </parameter_description> </parameter> </parameters> -<return> a #GFileAttributeInfoList describing the writable namespaces. -When you are done with it, release it with g_file_attribute_info_list_unref() -</return> +<return></return> </function> <function name="g_file_info_set_attribute_uint32"> @@ -5433,6 +5269,9 @@ Completes an asynchronous function in an idle handler in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread that @simple was initially created in. +Calling this function takes a reference to @simple for as long as +is needed to complete the call. + </description> <parameters> <parameter name="simple"> @@ -5468,40 +5307,27 @@ ignore. </return> </function> -<function name="g_socket_listener_add_any_inet_port"> +<function name="g_file_info_set_attribute_byte_string"> <description> -Listens for TCP connections on any available port number for both -IPv6 and IPv4 (if each are available). - -This is useful if you need to have a socket for incoming connections -but don't care about the specific port number. - -@source_object will be passed out in the various calls -to accept to identify this particular source, which is -useful if you're listening on multiple addresses and do -different things depending on what address is connected to. - +Sets the @attribute to contain the given @attr_value, +if possible. </description> <parameters> -<parameter name="listener"> -<parameter_description> a #GSocketListener +<parameter name="info"> +<parameter_description> a #GFileInfo. </parameter_description> </parameter> -<parameter name="source_object"> -<parameter_description> Optional #GObject identifying this source +<parameter name="attribute"> +<parameter_description> a file attribute key. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="attr_value"> +<parameter_description> a byte string. </parameter_description> </parameter> </parameters> -<return> the port number, or 0 in case of failure. - -Since: 2.24 -</return> +<return></return> </function> <function name="g_inet_address_get_is_link_local"> @@ -5510,6 +5336,7 @@ Tests whether @address is a link-local address (that is, if it identifies a host on a local network that is not connected to the Internet). +Since: 2.22 </description> <parameters> @@ -5520,36 +5347,28 @@ Internet). </parameters> <return> %TRUE if @address is a link-local address. -Since: 2.22 </return> </function> -<function name="g_async_initable_new_finish"> +<function name="g_emblem_new_with_origin"> <description> -Finishes the async construction for the various g_async_initable_new calls, -returning the created object or %NULL on error. +Creates a new emblem for @icon. +Since: 2.18 </description> <parameters> -<parameter name="initable"> -<parameter_description> the #GAsyncInitable from the callback -</parameter_description> -</parameter> -<parameter name="res"> -<parameter_description> the #GAsyncResult.from the callback +<parameter name="icon"> +<parameter_description> a GIcon containing the icon. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="origin"> +<parameter_description> a GEmblemOrigin enum defining the emblem's origin </parameter_description> </parameter> </parameters> -<return> a newly created #GObject, or %NULL on error. Free with -g_object_unref(). +<return> a new #GEmblem. -Since: 2.22 </return> </function> @@ -5609,15 +5428,15 @@ Gets the operation result boolean from within the asynchronous result. </parameter_description> </parameter> </parameters> -<return> %TRUE if the operation's result was %TRUE, %FALSE -if the operation's result was %FALSE. +<return> %TRUE if the operation's result was %TRUE, %FALSE +if the operation's result was %FALSE. </return> </function> <function name="g_simple_async_result_set_op_res_gssize"> <description> -Sets the operation result within the asynchronous result to -the given @op_res. +Sets the operation result within the asynchronous result to +the given @op_res. </description> <parameters> @@ -5639,6 +5458,7 @@ Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting. +Since: 2.22 </description> <parameters> @@ -5654,7 +5474,6 @@ either explicitly or implicitly when connecting. <return> a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -5662,6 +5481,7 @@ Since: 2.22 <description> Return the UNIX file descriptor that the stream writes to. +Since: 2.20 </description> <parameters> @@ -5672,7 +5492,6 @@ Return the UNIX file descriptor that the stream writes to. </parameters> <return> The file descriptor of @stream -Since: 2.20 </return> </function> @@ -5724,6 +5543,7 @@ ignore. Gets the size of the native raw binary address for @address. This is the size of the data that you get from g_inet_address_to_bytes(). +Since: 2.22 </description> <parameters> @@ -5734,7 +5554,6 @@ is the size of the data that you get from g_inet_address_to_bytes(). </parameters> <return> the number of bytes used for the native version of @address. -Since: 2.22 </return> </function> @@ -5745,13 +5564,13 @@ with it. #GResolver may use its reference count as a hint about how many threads/processes, etc it should allocate for concurrent DNS resolutions. +Since: 2.22 </description> <parameters> </parameters> <return> the default #GResolver. -Since: 2.22 </return> </function> @@ -5901,6 +5720,7 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. +Since: 2.22 </description> <parameters> @@ -5923,27 +5743,9 @@ be returned. </parameters> <return> a #GFileInfo for the @stream, or %NULL on error. -Since: 2.22 </return> </function> -<function name="GMount"> -<description> -This signal is emitted when the #GMount is about to be -unmounted. - -Since: 2.22 - -</description> -<parameters> -<parameter name="mount"> -<parameter_description> the object on which the signal is emitted -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_content_type_can_be_executable"> <description> Checks if a content type can be executable. Note that for instance @@ -5967,6 +5769,7 @@ can be executable, %FALSE otherwise. Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. +Deprecated: 2.22: Use g_mount_eject_with_operation_finish() instead. </description> <parameters> @@ -5986,21 +5789,9 @@ ignore. </parameters> <return> %TRUE if the mount was successfully ejected. %FALSE otherwise. -Deprecated: 2.22: Use g_mount_eject_with_operation_finish() instead. </return> </function> -<function name="GUnixSocketAddress"> -<description> -A UNIX-domain (local) socket address, corresponding to a -<type>struct sockaddr_un</type>. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_output_stream_set_pending"> <description> Sets @stream to have actions pending. If the pending flag is @@ -6152,22 +5943,28 @@ required. </return> </function> -<function name="g_data_output_stream_set_byte_order"> +<function name="g_io_modules_load_all_in_directory"> <description> -Sets the byte order of the data output stream to @order. +Loads all the modules in the specified directory. + +If don't require all modules to be initialized (and thus registering +all gtypes) then you can use g_io_modules_scan_all_in_directory() +which allows delayed/lazy loading of modules. + </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GDataOutputStream. -</parameter_description> -</parameter> -<parameter name="order"> -<parameter_description> a %GDataStreamByteOrder. +<parameter name="dirname"> +<parameter_description> pathname for a directory containing modules to load. </parameter_description> </parameter> </parameters> -<return></return> +<return> a list of #GIOModules loaded from the directory, +All the modules are loaded into memory, if you want to +unload them (enabling on-demand loading) you must call +g_type_module_unuse() on all the modules. Free the list +with g_list_free(). +</return> </function> <function name="g_io_extension_get_priority"> @@ -6258,6 +6055,7 @@ Creates a new converter output stream for the @base_stream. Gets the display name of the application. The display name is often more descriptive to the user than the name itself. +Since: 2.24 </description> <parameters> @@ -6269,31 +6067,22 @@ descriptive to the user than the name itself. <return> the display name of the application for @appinfo, or the name if no display name is available. -Since: 2.24 </return> </function> -<function name="g_buffered_input_stream_fill_finish"> +<function name="g_io_error_from_errno"> <description> -Finishes an asynchronous read. +Converts errno.h error codes into GIO error codes. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GBufferedInputStream. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError. +<parameter name="err_no"> +<parameter_description> Error number as defined in errno.h. </parameter_description> </parameter> </parameters> -<return> a #gssize of the read stream, or %-1 on an error. +<return> #GIOErrorEnum value for the given errno.h error number. </return> </function> @@ -6333,40 +6122,11 @@ Emits the #GMountOperation::reply signal. <return></return> </function> -<function name="g_themed_icon_new_with_default_fallbacks"> -<description> -Creates a new themed icon for @iconname, and all the names -that can be created by shortening @iconname at '-' characters. - -In the following example, @icon1 and @icon2 are equivalent: -|[ -const char *names[] = { -"gnome-dev-cdrom-audio", -"gnome-dev-cdrom", -"gnome-dev", -"gnome" -}; - -icon1 = g_themed_icon_new_from_names (names, 4); -icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); -]| - - -</description> -<parameters> -<parameter name="iconname"> -<parameter_description> a string containing an icon name -</parameter_description> -</parameter> -</parameters> -<return> a new #GThemedIcon. -</return> -</function> - <function name="g_file_attribute_matcher_matches_only"> <description> Checks if a attribute matcher only matches a given attribute. Always -Returns: %TRUE if the matcher only matches @attribute. %FALSE otherwise. +returns %FALSE if "*" was used when creating the matcher. + </description> <parameters> @@ -6404,6 +6164,7 @@ Checks if a drive can be ejected. Creates a #GSocketAddress subclass corresponding to the native <type>struct sockaddr</type> @native. +Since: 2.22 </description> <parameters> @@ -6419,7 +6180,6 @@ Creates a #GSocketAddress subclass corresponding to the native <return> a new #GSocketAddress if @native could successfully be converted, otherwise %NULL. -Since: 2.22 </return> </function> @@ -6427,6 +6187,7 @@ Since: 2.22 <description> Get the #GFile container which is being enumerated. +Since: 2.18 </description> <parameters> @@ -6437,7 +6198,6 @@ Get the #GFile container which is being enumerated. </parameters> <return> the #GFile which is being enumerated. -Since: 2.18 </return> </function> @@ -6510,6 +6270,7 @@ ignore. <description> Tests whether @address is a node-local multicast address. +Since: 2.22 </description> <parameters> @@ -6520,7 +6281,6 @@ Tests whether @address is a node-local multicast address. </parameters> <return> %TRUE if @address is a node-local multicast address. -Since: 2.22 </return> </function> @@ -6528,6 +6288,7 @@ Since: 2.22 <description> Finishes starting a drive. +Since: 2.22 </description> <parameters> @@ -6547,42 +6308,9 @@ Finishes starting a drive. <return> %TRUE if the drive has been started successfully, %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_socket_listener_accept_socket_async"> -<description> -This is the asynchronous version of g_socket_listener_accept_socket(). - -When the operation is finished @callback will be -called. You can then call g_socket_listener_accept_socket_finish() -to get the result of the operation. - -Since: 2.22 - -</description> -<parameters> -<parameter name="listener"> -<parameter_description> a #GSocketListener -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> a #GCancellable, or %NULL -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> user data for the callback -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_cancellable_push_current"> <description> Pushes @cancellable onto the cancellable stack. The current @@ -6669,7 +6397,13 @@ g_output_stream_write(). <function name="get_all_desktop_entries_for_mime_type"> <description> -Return value: a #GList containing the desktop ids which claim +Returns all the desktop ids for @mime_type. The desktop files +are listed in an order so that default applications are listed before +non-default ones, and handlers for inherited mimetypes are listed +after the base ones. + +Optionally doesn't list the desktop ids given in the @except + </description> <parameters> @@ -6687,6 +6421,24 @@ to handle @mime_type. </return> </function> +<function name="g_socket_address_get_family"> +<description> +Gets the socket family type of @address. + +Since: 2.22 + +</description> +<parameters> +<parameter name="address"> +<parameter_description> a #GSocketAddress +</parameter_description> +</parameter> +</parameters> +<return> the socket family type of @address. + +</return> +</function> + <function name="g_socket_set_keepalive"> <description> Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When @@ -6721,9 +6473,46 @@ Since: 2.22 <return></return> </function> +<function name="g_network_service_get_domain"> +<description> +Gets the domain that @srv serves. This might be either UTF-8 or +ASCII-encoded, depending on what @srv was created with. + +Since: 2.22 + +</description> +<parameters> +<parameter name="srv"> +<parameter_description> a #GNetworkService +</parameter_description> +</parameter> +</parameters> +<return> @srv's domain name + +</return> +</function> + <function name="g_unix_fd_message_steal_fds"> <description> -Returns: an array of file descriptors +Returns the array of file descriptors that is contained in this +object. + +After this call, the descriptors are no longer contained in +@message. Further calls will return an empty list (unless more +descriptors have been added). + +The return result of this function must be freed with g_free(). +The caller is also responsible for closing all of the file +descriptors. + +If @length is non-%NULL then it is set to the number of file +descriptors in the returned array. The returned array is also +terminated with -1. + +This function never returns %NULL. In case there are no file +descriptors contained in @message, an empty array is returned. + +Since: 2.22 </description> <parameters> @@ -6738,7 +6527,6 @@ Returns: an array of file descriptors </parameters> <return> an array of file descriptors -Since: 2.22 </return> </function> @@ -6783,6 +6571,7 @@ is met, %TRUE is returned. If @cancellable is cancelled before the condition is met then %FALSE is returned and @error, if non-%NULL, is set to %G_IO_ERROR_CANCELLED. +Since: 2.22 </description> <parameters> @@ -6805,7 +6594,6 @@ is returned and @error, if non-%NULL, is set to %G_IO_ERROR_CANCELLED. </parameters> <return> %TRUE if the condition was met, %FALSE otherwise -Since: 2.22 </return> </function> @@ -6813,6 +6601,7 @@ Since: 2.22 <description> Gives back the icon from @emblem. +Since: 2.18 </description> <parameters> @@ -6824,7 +6613,6 @@ Gives back the icon from @emblem. <return> a #GIcon. The returned object belongs to the emblem and should not be modified or freed. -Since: 2.18 </return> </function> @@ -6844,30 +6632,6 @@ Checks if a unix mount point is read only. </return> </function> -<function name="g_file_enumerator_next_file"> -<description> -Return value: A #GFileInfo or %NULL on error or end of enumerator. - -</description> -<parameters> -<parameter name="enumerator"> -<parameter_description> a #GFileEnumerator. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore -</parameter_description> -</parameter> -</parameters> -<return> A #GFileInfo or %NULL on error or end of enumerator. -Free the returned object with g_object_unref() when no longer needed. -</return> -</function> - <function name="g_file_info_set_symlink_target"> <description> Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info @@ -6887,19 +6651,22 @@ to the given symlink target. <return></return> </function> -<function name="g_mount_operation_get_domain"> +<function name="g_unix_fd_list_get_length"> <description> -Gets the domain of the mount operation. +Gets the length of @list (ie: the number of file descriptors +contained within). +Since: 2.24 </description> <parameters> -<parameter name="op"> -<parameter_description> a #GMountOperation. +<parameter name="list"> +<parameter_description> a #GUnixFDList </parameter_description> </parameter> </parameters> -<return> a string set to the domain. +<return> the length of @list + </return> </function> @@ -6924,52 +6691,19 @@ or less than @mount2, respectively. </return> </function> -<function name="g_drive_get_identifier"> -<description> -Gets the identifier of the given kind for @drive. - - -</description> -<parameters> -<parameter name="drive"> -<parameter_description> a #GDrive -</parameter_description> -</parameter> -<parameter name="kind"> -<parameter_description> the kind of identifier to return -</parameter_description> -</parameter> -</parameters> -<return> a newly allocated string containing the -requested identfier, or %NULL if the #GDrive -doesn't have this kind of identifier. -</return> -</function> - -<function name="GThreadedSocketService"> +<function name="g_file_info_get_display_name"> <description> -The ::run signal is emitted in a worker thread in response to an -incoming connection. This thread is dedicated to handling -@connection and may perform blocking IO. The signal handler need -not return until the connection is closed. +Gets a display name for a file. </description> <parameters> -<parameter name="service"> -<parameter_description> the #GThreadedSocketService. -</parameter_description> -</parameter> -<parameter name="connection"> -<parameter_description> a new #GSocketConnection object. -</parameter_description> -</parameter> -<parameter name="source_object"> -<parameter_description> the source_object passed to g_socket_listener_add_address(). +<parameter name="info"> +<parameter_description> a #GFileInfo. </parameter_description> </parameter> </parameters> -<return> %TRUE to stope further signal handlers from being called +<return> a string containing the display name. </return> </function> @@ -7017,26 +6751,32 @@ accordingly. </return> </function> -<function name="g_file_info_get_attribute_int32"> +<function name="g_socket_address_enumerator_next_async"> <description> -Gets a signed 32-bit integer contained within the attribute. If the -attribute does not contain a signed 32-bit integer, or is invalid, -0 will be returned. - +Asynchronously retrieves the next #GSocketAddress from @enumerator +and then calls @callback, which must call +g_socket_address_enumerator_next_finish() to get the result. </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="enumerator"> +<parameter_description> a #GSocketAddressEnumerator </parameter_description> </parameter> -<parameter name="attribute"> -<parameter_description> a file attribute key. +<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> a signed 32-bit integer from the attribute. -</return> +<return></return> </function> <function name="g_socket_speaks_ipv4"> @@ -7051,6 +6791,7 @@ information. No other types of sockets are currently considered as being capable of speaking IPv4. +Since: 2.22 </description> <parameters> @@ -7061,7 +6802,6 @@ of speaking IPv4. </parameters> <return> %TRUE if this socket can be used with IPv4. -Since: 2.22. </return> </function> @@ -7071,6 +6811,7 @@ Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. +Since: 2.22 </description> <parameters> @@ -7086,13 +6827,31 @@ ignore </parameters> <return> %TRUE if pending was previously unset and is now set. -Since: 2.22 </return> </function> <function name="g_unix_fd_list_steal_fds"> <description> -Returns: an array of file descriptors +Returns the array of file descriptors that is contained in this +object. + +After this call, the descriptors are no longer contained in +@list. Further calls will return an empty list (unless more +descriptors have been added). + +The return result of this function must be freed with g_free(). +The caller is also responsible for closing all of the file +descriptors. The file descriptors in the array are set to +close-on-exec. + +If @length is non-%NULL then it is set to the number of file +descriptors in the returned array. The returned array is also +terminated with -1. + +This function never returns %NULL. In case there are no file +descriptors contained in @list, an empty array is returned. + +Since: 2.24 </description> <parameters> @@ -7107,70 +6866,23 @@ Returns: an array of file descriptors </parameters> <return> an array of file descriptors -Since: 2.24 -</return> -</function> - -<function name="g_simple_async_result_is_valid"> -<description> -Ensures that the data passed to the _finish function of an async -operation is consistent. Three checks are performed. - -First, @result is checked to ensure that it is really a -#GSimpleAsyncResult. Second, @source is checked to ensure that it -matches the source object of @result. Third, @source_tag is -checked to ensure that it is equal to the source_tag argument given -to g_simple_async_result_new() (which, by convention, is a pointer -to the _async function corresponding to the _finish function from -which this function is called). - - -</description> -<parameters> -<parameter name="result"> -<parameter_description> the #GAsyncResult passed to the _finish function. -</parameter_description> -</parameter> -<parameter name="source"> -<parameter_description> the #GObject passed to the _finish function. -</parameter_description> -</parameter> -<parameter name="source_tag"> -<parameter_description> the asynchronous function. -</parameter_description> -</parameter> -</parameters> -<return> #TRUE if all checks passed or #FALSE if any failed. </return> </function> -<function name="g_file_unmount_mountable_finish"> +<function name="g_mount_operation_get_choice"> <description> -Finishes an unmount operation, see g_file_unmount_mountable() for details. - -Finish an asynchronous unmount operation that was started -with g_file_unmount_mountable(). +Gets a choice from the mount operation. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="op"> +<parameter_description> a #GMountOperation. </parameter_description> </parameter> </parameters> -<return> %TRUE if the operation finished successfully. %FALSE -otherwise. - -Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead. +<return> an integer containing an index of the user's choice from +the choice's list, or %0. </return> </function> @@ -7234,36 +6946,6 @@ when no longer needed. </return> </function> -<function name="g_app_launch_context_get_startup_notify_id"> -<description> -Initiates startup notification for the application and returns the -DESKTOP_STARTUP_ID for the launched operation, if supported. - -Startup notification IDs are defined in the <ulink -url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"> -FreeDesktop.Org Startup Notifications standard</ulink>. - - -</description> -<parameters> -<parameter name="context"> -<parameter_description> a #GAppLaunchContext -</parameter_description> -</parameter> -<parameter name="info"> -<parameter_description> a #GAppInfo -</parameter_description> -</parameter> -<parameter name="files"> -<parameter_description> a #GList of of #GFile objects -</parameter_description> -</parameter> -</parameters> -<return> a startup notification ID for the application, or %NULL if -not supported. -</return> -</function> - <function name="g_file_has_prefix"> <description> Checks whether @file has the prefix specified by @prefix. In other word, @@ -7309,38 +6991,6 @@ Gets the device path for a unix mount point. </return> </function> -<function name="GNetworkService"> -<description> -A #GSocketConnectable for resolving a SRV record and connecting to -that service. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_unix_output_stream_set_close_fd"> -<description> -Sets whether the file descriptor of @stream shall be closed -when the stream is closed. - -Since: 2.20 - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a #GUnixOutputStream -</parameter_description> -</parameter> -<parameter name="close_fd"> -<parameter_description> %TRUE to close the file descriptor when done -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_mount_get_drive"> <description> Gets the drive for the @mount. @@ -7435,6 +7085,7 @@ Creates a new #GUnixSocketAddress for @path. To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract(). +Since: 2.22 </description> <parameters> @@ -7445,49 +7096,41 @@ use g_unix_socket_address_new_abstract(). </parameters> <return> a new #GUnixSocketAddress -Since: 2.22 </return> </function> -<function name="g_resolver_lookup_by_name_async"> +<function name="g_file_enumerator_next_files_finish"> <description> -Begins asynchronously resolving @hostname to determine its -associated IP address(es), and eventually calls @callback, which -must call g_resolver_lookup_by_name_finish() to get the result. -See g_resolver_lookup_by_name() for more details. +Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). -Since: 2.22 </description> <parameters> -<parameter name="resolver"> -<parameter_description> a #GResolver -</parameter_description> -</parameter> -<parameter name="hostname"> -<parameter_description> the hostname to look up the address of -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> a #GCancellable, or %NULL +<parameter name="enumerator"> +<parameter_description> a #GFileEnumerator. </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> callback to call after resolution completes +<parameter name="result"> +<parameter_description> a #GAsyncResult. </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> data for @callback +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GList of #GFileInfo<!---->s. You must free the list with +g_list_free() and unref the infos with g_object_unref() when you're +done with them. +</return> </function> <function name="g_drive_get_start_stop_type"> <description> Gets a hint about how a drive can be started/stopped. +Since: 2.22 </description> <parameters> @@ -7498,7 +7141,6 @@ Gets a hint about how a drive can be started/stopped. </parameters> <return> A value from the #GDriveStartStopType enumeration. -Since: 2.22 </return> </function> @@ -7528,6 +7170,22 @@ This call does no blocking i/o. </return> </function> +<function name="g_themed_icon_new"> +<description> +Creates a new themed icon for @iconname. + + +</description> +<parameters> +<parameter name="iconname"> +<parameter_description> a string containing an icon name. +</parameter_description> +</parameter> +</parameters> +<return> a new #GThemedIcon. +</return> +</function> + <function name="g_file_set_attributes_async"> <description> Asynchronously sets the attributes of @file with @info. @@ -7577,6 +7235,7 @@ of the request. <description> Tests whether @address is a global multicast address. +Since: 2.22 </description> <parameters> @@ -7587,7 +7246,25 @@ Tests whether @address is a global multicast address. </parameters> <return> %TRUE if @address is a global multicast address. -Since: 2.22 +</return> +</function> + +<function name="g_volume_monitor_get_mounts"> +<description> +Gets a list of the mounts on the system. + +The returned list should be freed with g_list_free(), after +its elements have been unreffed with g_object_unref(). + + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> a #GVolumeMonitor. +</parameter_description> +</parameter> +</parameters> +<return> a #GList of #GMount objects. </return> </function> @@ -7596,6 +7273,7 @@ Since: 2.22 Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). +Since: 2.22 </description> <parameters> @@ -7615,7 +7293,6 @@ g_file_create_readwrite_async(). <return> a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -7651,6 +7328,7 @@ g_tcp_connection_set_graceful_disconnect(). But of course, this only works if the client will close its connection after the server does.) +Since: 2.22 </description> <parameters> @@ -7665,7 +7343,6 @@ does.) </parameters> <return> %TRUE on success, %FALSE on error -Since: 2.22 </return> </function> @@ -7782,7 +7459,10 @@ Free the returned object with g_object_unref(). <function name="g_unix_input_stream_get_close_fd"> <description> -Return value: %TRUE if the file descriptor is closed when done +Returns whether the file descriptor of @stream will be +closed when the stream is closed. + +Since: 2.20 </description> <parameters> @@ -7793,7 +7473,6 @@ Return value: %TRUE if the file descriptor is closed when done </parameters> <return> %TRUE if the file descriptor is closed when done -Since: 2.20 </return> </function> @@ -7836,47 +7515,45 @@ classes. However, if you override one you must override all. <return></return> </function> -<function name="g_mount_operation_get_password_save"> +<function name="g_app_info_launch"> <description> -Gets the state of saving passwords for the mount operation. +Launches the application. Passes @files to the launched application +as arguments, using the optional @launch_context to get information +about the details of the launcher (like what screen it is on). +On error, @error will be set accordingly. +To lauch the application without arguments pass a %NULL @files list. -</description> -<parameters> -<parameter name="op"> -<parameter_description> a #GMountOperation. -</parameter_description> -</parameter> -</parameters> -<return> a #GPasswordSave flag. -</return> -</function> +Note that even if the launch is successful the application launched +can fail to start if it runs into problems during startup. There is +no way to detect this. -<function name="g_data_output_stream_put_uint32"> -<description> -Puts an unsigned 32-bit integer into the stream. +Some URIs can be changed when passed through a GFile (for instance +unsupported uris with strange formats like mailto:), so if you have +a textual uri you want to pass in as argument, consider using +g_app_info_launch_uris() instead. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GDataOutputStream. +<parameter name="appinfo"> +<parameter_description> a #GAppInfo </parameter_description> </parameter> -<parameter name="data"> -<parameter_description> a #guint32. +<parameter name="files"> +<parameter_description> a #GList of #GFile objects </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="launch_context"> +<parameter_description> a #GAppLaunchContext or %NULL </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError, %NULL to ignore. +<parameter_description> a #GError </parameter_description> </parameter> </parameters> -<return> %TRUE if @data was successfully added to the @stream. +<return> %TRUE on successful launch, %FALSE otherwise. </return> </function> @@ -7886,6 +7563,7 @@ Gets the local address of the socket client. See g_socket_client_set_local_address() for details. +Since: 2.22 </description> <parameters> @@ -7896,7 +7574,6 @@ See g_socket_client_set_local_address() for details. </parameters> <return> a #GSocketAddres or %NULL. don't free -Since: 2.22 </return> </function> @@ -7917,6 +7594,24 @@ a buffer set to the default size (4 kilobytes). </return> </function> +<function name="g_content_type_from_mime_type"> +<description> +Tries to find a content type based on the mime type name. + +Since: 2.18 + +</description> +<parameters> +<parameter name="mime_type"> +<parameter_description> a mime type string. +</parameter_description> +</parameter> +</parameters> +<return> Newly allocated string with content type or NULL when does not know. + +</return> +</function> + <function name="g_content_type_guess"> <description> Guesses the content type based on example data. If the function is @@ -7949,47 +7644,65 @@ given data. </return> </function> -<function name="g_network_service_new"> +<function name="g_simple_async_result_set_error_va"> <description> -Creates a new #GNetworkService representing the given @service, -@protocol, and @domain. This will initially be unresolved; use the -#GSocketConnectable interface to resolve it. - +Sets an error within the asynchronous result without a #GError. +Unless writing a binding, see g_simple_async_result_set_error(). </description> <parameters> -<parameter name="service"> -<parameter_description> the service type to look up (eg, "ldap") +<parameter name="simple"> +<parameter_description> a #GSimpleAsyncResult. </parameter_description> </parameter> -<parameter name="protocol"> -<parameter_description> the networking protocol to use for @service (eg, "tcp") +<parameter name="domain"> +<parameter_description> a #GQuark (usually #G_IO_ERROR). </parameter_description> </parameter> -<parameter name="domain"> -<parameter_description> the DNS domain to look up the service in +<parameter name="code"> +<parameter_description> an error code. +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> a formatted error reporting string. +</parameter_description> +</parameter> +<parameter name="args"> +<parameter_description> va_list of arguments. </parameter_description> </parameter> </parameters> -<return> a new #GNetworkService - -Since: 2.22 -</return> +<return></return> </function> -<function name="g_socket_client_new"> +<function name="g_drive_poll_for_media"> <description> -Creates a new #GSocketClient with the default options. +Asynchronously polls @drive to see if media has been inserted or removed. +When the operation is finished, @callback will be called. +You can then call g_drive_poll_for_media_finish() to obtain the +result of the operation. </description> <parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback, or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data to pass to @callback +</parameter_description> +</parameter> </parameters> -<return> a #GSocketClient. -Free the returned object with g_object_unref(). - -Since: 2.22 -</return> +<return></return> </function> <function name="g_file_enumerator_has_pending"> @@ -8016,6 +7729,7 @@ g_socket_connect()). See g_socket_send() for additional information. +Since: 2.22 </description> <parameters> @@ -8047,7 +7761,6 @@ See g_socket_send() for additional information. <return> Number of bytes written (which may be less than @size), or -1 on error -Since: 2.22 </return> </function> @@ -8086,22 +7799,35 @@ not supported. </return> </function> -<function name="g_mount_operation_set_anonymous"> +<function name="g_file_query_writable_namespaces"> <description> -Sets the mount operation to use an anonymous user if @anonymous is %TRUE. +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. + </description> <parameters> -<parameter name="op"> -<parameter_description> a #GMountOperation. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="anonymous"> -<parameter_description> boolean value. +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GFileAttributeInfoList describing the writable namespaces. +When you are done with it, release it with g_file_attribute_info_list_unref() +</return> </function> <function name="g_data_input_stream_read_line_finish"> @@ -8109,6 +7835,7 @@ Sets the mount operation to use an anonymous user if @anonymous is %TRUE. Finish an asynchronous call started by g_data_input_stream_read_line_async(). +Since: 2.20 </description> <parameters> @@ -8134,7 +7861,6 @@ Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. If there's no content to read, it will still return %NULL, but @error won't be set. -Since: 2.20 </return> </function> @@ -8154,30 +7880,6 @@ Gets the icon for a content type. </return> </function> -<function name="SECTION"> -<description> -Data output stream implements #GOutputStream and includes functions for -writing data directly to an output stream. - - -</description> -<parameters> -<parameter name="short_description"> -<parameter_description> Data Output Stream -</parameter_description> -</parameter> -<parameter name="include"> -<parameter_description> gio/gio.h -</parameter_description> -</parameter> -<parameter name="see_also"> -<parameter_description> #GOutputStream -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_file_eject_mountable_with_operation"> <description> Starts an asynchronous eject on a mountable. @@ -8272,6 +7974,7 @@ Gets @target's priority. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. +Since: 2.22 </description> <parameters> @@ -8282,64 +7985,44 @@ RFC 2782. </parameters> <return> @target's priority -Since: 2.22 </return> </function> -<function name="GVolumeMonitor"> +<function name="g_zlib_decompressor_new"> <description> -Emitted when the stop button is pressed on @drive. +Creates a new #GZlibDecompressor. -Since: 2.22 +Since: 2.24 </description> <parameters> -<parameter name="volume_monitor"> -<parameter_description> The volume monitor emitting the signal. -</parameter_description> -</parameter> -<parameter name="drive"> -<parameter_description> the drive where the stop button was pressed +<parameter name="format"> +<parameter_description> The format to use for the compressed data </parameter_description> </parameter> </parameters> -<return></return> -</function> - -<function name="g_mount_operation_get_choice"> -<description> -Gets a choice from the mount operation. - +<return> a new #GZlibDecompressor -</description> -<parameters> -<parameter name="op"> -<parameter_description> a #GMountOperation. -</parameter_description> -</parameter> -</parameters> -<return> an integer containing an index of the user's choice from -the choice's list, or %0. </return> </function> -<function name="g_file_info_set_icon"> +<function name="g_io_extension_get_name"> <description> -Sets the icon for a given #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_ICON. +Gets the name under which @extension was registered. + +Note that the same type may be registered as extension +for multiple extension points, under different names. + </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. -</parameter_description> -</parameter> -<parameter name="icon"> -<parameter_description> a #GIcon. +<parameter name="extension"> +<parameter_description> a #GIOExtension </parameter_description> </parameter> </parameters> -<return></return> +<return> the name of @extension. +</return> </function> <function name="g_io_scheduler_cancel_all_jobs"> @@ -8360,6 +8043,7 @@ g_io_scheduler_push_job(). Creates a #GSocketConnection subclass of the right type for @socket. +Since: 2.22 </description> <parameters> @@ -8370,40 +8054,9 @@ Creates a #GSocketConnection subclass of the right type for </parameters> <return> a #GSocketConnection -Since: 2.22 </return> </function> -<function name="g_drive_poll_for_media"> -<description> -Asynchronously polls @drive to see if media has been inserted or removed. - -When the operation is finished, @callback will be called. -You can then call g_drive_poll_for_media_finish() to obtain the -result of the operation. - -</description> -<parameters> -<parameter name="drive"> -<parameter_description> a #GDrive. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback, or %NULL. -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> user data to pass to @callback -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_file_trash"> <description> Sends @file to the "Trashcan", if possible. This is similar to @@ -8440,13 +8093,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <description> Creates a new #GUnixFDList containing no file descriptors. +Since: 2.24 </description> <parameters> </parameters> <return> a new #GUnixFDList -Since: 2.24 </return> </function> @@ -8455,6 +8108,7 @@ Since: 2.24 Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, depending on what @addr was created with. +Since: 2.22 </description> <parameters> @@ -8465,28 +8119,53 @@ depending on what @addr was created with. </parameters> <return> @addr's hostname -Since: 2.22 </return> </function> -<function name="g_app_info_get_commandline"> +<function name="g_file_input_stream_query_info_async"> <description> -Gets the commandline with which the application will be -started. +Queries the stream information asynchronously. +When the operation is finished @callback will be called. +You can then call g_file_input_stream_query_info_finish() +to get the result of the operation. + +For the synchronous version of this function, +see g_file_input_stream_query_info(). + +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be set </description> <parameters> -<parameter name="appinfo"> -<parameter_description> a #GAppInfo +<parameter name="stream"> +<parameter_description> a #GFileInputStream. +</parameter_description> +</parameter> +<parameter name="attributes"> +<parameter_description> a file 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> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback 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> a string containing the @appinfo's commandline, -or %NULL if this information is not available - -Since: 2.20 -</return> +<return></return> </function> <function name="g_file_unmount_mountable_with_operation_finish"> @@ -8496,6 +8175,7 @@ Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation(). +Since: 2.22 </description> <parameters> @@ -8515,69 +8195,26 @@ with g_file_unmount_mountable_with_operation(). <return> %TRUE if the operation finished successfully. %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_unix_fd_message_append_fd"> -<description> -Adds a file descriptor to @message. - -The file descriptor is duplicated using dup(). You keep your copy -of the descriptor and the copy contained in @message will be closed -when @message is finalized. - -A possible cause of failure is exceeding the per-process or -system-wide file descriptor limit. - - -</description> -<parameters> -<parameter name="message"> -<parameter_description> a #GUnixFDMessage -</parameter_description> -</parameter> -<parameter name="fd"> -<parameter_description> a valid open file descriptor -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError pointer -</parameter_description> -</parameter> -</parameters> -<return> %TRUE in case of success, else %FALSE (and @error is set) - -Since: 2.22 -</return> -</function> - -<function name="g_data_output_stream_put_uint64"> +<function name="g_simple_async_result_set_handle_cancellation"> <description> -Puts an unsigned 64-bit integer into the stream. +Sets whether to handle cancellation within the asynchronous operation. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GDataOutputStream. -</parameter_description> -</parameter> -<parameter name="data"> -<parameter_description> a #guint64. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="simple"> +<parameter_description> a #GSimpleAsyncResult. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, %NULL to ignore. +<parameter name="handle_cancellation"> +<parameter_description> a #gboolean. </parameter_description> </parameter> </parameters> -<return> %TRUE if @data was successfully added to the @stream. -</return> +<return></return> </function> <function name="g_file_get_parent"> @@ -8602,17 +8239,6 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="GSocketAddress"> -<description> -A socket endpoint address, corresponding to <type>struct sockaddr</type> -or one of its subtypes. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_file_set_attribute_byte_string"> <description> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. @@ -8658,7 +8284,8 @@ in the @file, %FALSE otherwise. <function name="g_file_monitor_is_cancelled"> <description> -Returns: %TRUE if monitor is canceled. %FALSE otherwise. +Returns whether the monitor is canceled. + </description> <parameters> @@ -8671,30 +8298,46 @@ Returns: %TRUE if monitor is canceled. %FALSE otherwise. </return> </function> -<function name="g_io_stream_close_finish"> +<function name="g_file_set_attributes_from_info"> <description> -Closes a stream. +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 @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GIOStream +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult +<parameter name="info"> +<parameter_description> a #GFileInfo. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> #GFileQueryInfoFlags +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> %TRUE if stream was successfully closed, %FALSE otherwise. - -Since: 2.22 +<return> %TRUE if there was any error, %FALSE otherwise. </return> </function> @@ -8743,6 +8386,7 @@ sockets with the specified @family,@type and @protocol_id. If no type is registered, the #GSocketConnection base type is returned. +Since: 2.22 </description> <parameters> @@ -8761,20 +8405,22 @@ If no type is registered, the #GSocketConnection base type is returned. </parameters> <return> a #GType -Since: 2.22 </return> </function> -<function name="g_file_create_async"> +<function name="g_file_load_partial_contents_async"> <description> -Asynchronously creates a new file and returns an output stream for writing to it. -The file must not already exist. +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(). -For more details, see g_file_create() which is -the synchronous version of this call. +Users of this function should be aware that @user_data is passed to +both the @read_more_callback and the @callback. -When the operation is finished, @callback will be called. You can then call -g_file_create_finish() to get the result of the operation. +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> <parameters> @@ -8782,46 +8428,51 @@ g_file_create_finish() to get the result of the operation. <parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="flags"> -<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> -</parameter> <parameter name="cancellable"> <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> +</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> the data to pass to the callback functions. </parameter_description> </parameter> </parameters> <return></return> </function> -<function name="g_io_stream_is_closed"> +<function name="g_data_output_stream_put_uint32"> <description> -Checks if a stream is closed. +Puts an unsigned 32-bit integer into the stream. </description> <parameters> <parameter name="stream"> -<parameter_description> a #GIOStream +<parameter_description> a #GDataOutputStream. +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> a #guint32. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> %TRUE if the stream is closed. - -Since: 2.22 +<return> %TRUE if @data was successfully added to the @stream. </return> </function> @@ -8841,6 +8492,7 @@ One example where this is used is graceful disconnect for TCP connections where you close the sending side, then wait for the other side to close the connection, thus ensuring that the other side saw all sent data. +Since: 2.22 </description> <parameters> @@ -8863,7 +8515,6 @@ the connection, thus ensuring that the other side saw all sent data. </parameters> <return> %TRUE on success, %FALSE on error -Since: 2.22 </return> </function> @@ -8895,6 +8546,7 @@ The returned string should be freed with g_free() when no longer needed. <description> Tests whether @address is the loopback address for its family. +Since: 2.22 </description> <parameters> @@ -8905,7 +8557,6 @@ Tests whether @address is the loopback address for its family. </parameters> <return> %TRUE if @address is the loopback address for its family. -Since: 2.22 </return> </function> @@ -8932,6 +8583,7 @@ Finishes an stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). +Since: 2.22 </description> <parameters> @@ -8951,7 +8603,6 @@ with g_file_stop_mountable(). <return> %TRUE if the operation finished successfully. %FALSE otherwise. -Since: 2.22 </return> </function> @@ -8964,6 +8615,7 @@ or similar functions. The attribute must exist in @info for this to work. Otherwise %FALSE is returned and @info is unchanged. +Since: 2.22 </description> <parameters> @@ -8982,7 +8634,6 @@ is returned and @info is unchanged. </parameters> <return> %TRUE if the status was changed, %FALSE if the key was not set. -Since: 2.22 </return> </function> @@ -9007,16 +8658,20 @@ of the OS. </return> </function> -<function name="g_cancellable_get_current"> +<function name="g_file_info_get_etag"> <description> -Gets the top cancellable from the stack. +Gets the <link linkend="gfile-etag">entity tag</link> for a given +#GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE. </description> <parameters> +<parameter name="info"> +<parameter_description> a #GFileInfo. +</parameter_description> +</parameter> </parameters> -<return> a #GCancellable from the top of the stack, or %NULL -if the stack is empty. +<return> a string containing the value of the "etag:value" attribute. </return> </function> @@ -9054,6 +8709,7 @@ function; there's no need to listen for the 'mount-added' signal on <description> Creates a new emblemed icon for @icon with the emblem @emblem. +Since: 2.18 </description> <parameters> @@ -9068,7 +8724,6 @@ Creates a new emblemed icon for @icon with the emblem @emblem. </parameters> <return> a new #GIcon -Since: 2.18 </return> </function> @@ -9088,53 +8743,6 @@ Gets the icon for the application. </return> </function> -<function name="g_volume_get_activation_root"> -<description> -Gets the activation root for a #GVolume if it is known ahead of -mount time. Returns %NULL otherwise. If not %NULL and if @volume -is mounted, then the result of g_mount_get_root() on the -#GMount object obtained from g_volume_get_mount() will always -either be equal or a prefix of what this function returns. In -other words, in code - -<programlisting> -GMount *mount; -GFile *mount_root -GFile *volume_activation_root; - -mount = g_volume_get_mount (volume); /* mounted, so never NULL */ -mount_root = g_mount_get_root (mount); -volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */ -</programlisting> - -then the expression - -<programlisting> -(g_file_has_prefix (volume_activation_root, mount_root) || - g_file_equal (volume_activation_root, mount_root)) -</programlisting> - -will always be %TRUE. - -Activation roots are typically used in #GVolumeMonitor -implementations to find the underlying mount to shadow, see -g_mount_is_shadowed() for more details. - - -</description> -<parameters> -<parameter name="volume"> -<parameter_description> a #GVolume -</parameter_description> -</parameter> -</parameters> -<return> the activation root of @volume or %NULL. Use -g_object_unref() to free. - -Since: 2.18 -</return> -</function> - <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()). @@ -9206,28 +8814,38 @@ of the request. <return></return> </function> -<function name="g_volume_monitor_get_connected_drives"> +<function name="g_file_eject_mountable_finish"> <description> -Gets a list of drives connected to the system. - -The returned list should be freed with g_list_free(), after -its elements have been unreffed with g_object_unref(). +Finishes an asynchronous eject operation started by +g_file_eject_mountable(). +Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead. </description> <parameters> -<parameter name="volume_monitor"> -<parameter_description> a #GVolumeMonitor. +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> a #GList of connected #GDrive objects. +<return> %TRUE if the @file was ejected successfully. %FALSE +otherwise. + </return> </function> <function name="g_local_vfs_new"> <description> -Returns: a new #GVfs handle. +Returns a new #GVfs handle for a local vfs. + </description> <parameters> @@ -9291,6 +8909,9 @@ Polls @file for changes. Reads a string from the data input stream, up to the first occurrence of any of the stop characters. +Note that, in contrast to g_data_input_stream_read_until_async(), +this function consumes the stop character that it finds. + </description> <parameters> @@ -9374,6 +8995,22 @@ or less than @mount2, respectively. </return> </function> +<function name="g_unix_mount_guess_icon"> +<description> +Guesses the icon of a Unix mount. + + +</description> +<parameters> +<parameter name="mount_entry"> +<parameter_description> a #GUnixMountEntry +</parameter_description> +</parameter> +</parameters> +<return> a #GIcon +</return> +</function> + <function name="g_resolver_free_addresses"> <description> Frees @addresses (which should be the return value from @@ -9405,67 +9042,21 @@ Gets the local #GVfs for the system. </return> </function> -<function name="g_async_initable_init_async"> +<function name="g_filter_output_stream_get_close_base_stream"> <description> -Starts asynchronous initialization of the object implementing the -interface. This must be done before any real use of the object after -initial construction. If the object also implements #GInitable you can -optionally call g_initable_init() instead. - -When the initialization is finished, @callback will be called. You can -then call g_async_initable_init_finish() to get the result of the -initialization. - -Implementations may also support cancellation. If @cancellable is not -%NULL, then initialization 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, and -the object doesn't support cancellable initialization, the error -%G_IO_ERROR_NOT_SUPPORTED will be returned. - -If this function is not called, or returns with an error, then all -operations on the object should fail, generally returning the -error %G_IO_ERROR_NOT_INITIALIZED. - -Implementations of this method must be idempotent: i.e. multiple calls -to this function with the same argument should return the same results. -Only the first call initializes the object; further calls return the result -of the first call. This is so that it's safe to implement the singleton -pattern in the GObject constructor function. - -For classes that also support the #GInitable interface, the default -implementation of this method will run the g_initable_init() function -in a thread, so if you want to support asynchronous initialization via -threads, just implement the #GAsyncInitable interface without overriding -any interface methods. +Returns whether the base stream will be closed when @stream is +closed. -Since: 2.22 </description> <parameters> -<parameter name="initable"> -<parameter_description> a #GAsyncInitable. -</parameter_description> -</parameter> -<parameter name="io_priority"> -<parameter_description> the <link linkend="io-priority">I/O priority</link> -of the operation. -</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 name="stream"> +<parameter_description> a #GFilterOutputStream. </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE if the base stream will be closed. +</return> </function> <function name="g_file_is_native"> @@ -9537,15 +9128,43 @@ in the @file, %FALSE otherwise. </return> </function> -<function name="g_file_info_unset_attribute_mask"> +<function name="g_file_unmount_mountable_with_operation"> <description> -Unsets a mask set by g_file_info_set_attribute_mask(), if one -is set. +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. + +Since: 2.22 </description> <parameters> -<parameter name="info"> -<parameter_description> #GFileInfo. +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags affecting the operation +</parameter_description> +</parameter> +<parameter name="mount_operation"> +<parameter_description> a #GMountOperation, or %NULL to avoid user interaction. +</parameter_description> +</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, or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function </parameter_description> </parameter> </parameters> @@ -9586,10 +9205,43 @@ when no longer needed. </return> </function> +<function name="g_file_enumerator_next_file"> +<description> +Returns information for the next file in the enumerated object. +Will block until the information is available. The #GFileInfo +returned from this function will contain attributes that match the +attribute string that was passed when the #GFileEnumerator was created. + +On error, returns %NULL and sets @error to the error. If the +enumerator is at the end, %NULL will be returned and @error will +be unset. + + +</description> +<parameters> +<parameter name="enumerator"> +<parameter_description> a #GFileEnumerator. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> location to store the error occuring, or %NULL to ignore +</parameter_description> +</parameter> +</parameters> +<return> A #GFileInfo or %NULL on error or end of enumerator. +Free the returned object with g_object_unref() when no longer needed. +</return> +</function> + <function name="g_charset_converter_get_use_fallback"> <description> Gets the #GCharsetConverter:use-fallback property. +Since: 2.24 </description> <parameters> @@ -9600,7 +9252,6 @@ Gets the #GCharsetConverter:use-fallback property. </parameters> <return> %TRUE if fallbacks are used by @converter -Since: 2.24 </return> </function> @@ -9637,19 +9288,30 @@ Gets the attribute type, value and status for an attribute key. </return> </function> -<function name="g_seekable_can_truncate"> +<function name="g_io_stream_close_finish"> <description> -Tests if the stream can be truncated. +Closes a stream. +Since: 2.22 </description> <parameters> -<parameter name="seekable"> -<parameter_description> a #GSeekable. +<parameter name="stream"> +<parameter_description> a #GIOStream +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore </parameter_description> </parameter> </parameters> -<return> %TRUE if the stream can be truncated, %FALSE otherwise. +<return> %TRUE if stream was successfully closed, %FALSE otherwise. + </return> </function> @@ -9738,6 +9400,7 @@ at a partial multibyte sequence). Converters are supposed to try to produce as much output as possible and then return an error (typically %G_IO_ERROR_PARTIAL_INPUT). +Since: 2.24 </description> <parameters> @@ -9780,7 +9443,6 @@ to produce as much output as possible and then return an error </parameters> <return> a #GConverterResult, %G_CONVERTER_ERROR on error. -Since: 2.24 </return> </function> @@ -9828,42 +9490,19 @@ g_output_stream_splice(). <return></return> </function> -<function name="GDataStream"> -<description> -The :newline-type property determines what is considered -as a line ending when reading complete lines from the stream. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_data_output_stream_put_byte"> +<function name="g_unix_mount_guess_should_display"> <description> -Puts a byte into the output stream. +Guesses whether a Unix mount should be displayed in the UI. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GDataOutputStream. -</parameter_description> -</parameter> -<parameter name="data"> -<parameter_description> a #guchar. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, %NULL to ignore. +<parameter name="mount_entry"> +<parameter_description> a #GUnixMountEntry </parameter_description> </parameter> </parameters> -<return> %TRUE if @data was successfully added to the @stream. +<return> %TRUE if @mount_entry is deemed to be displayable. </return> </function> @@ -9888,6 +9527,7 @@ Checks if the unix mounts have changed since a given unix time. Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive(). +Since: 2.22 </description> <parameters> @@ -9898,7 +9538,6 @@ see g_socket_set_keepalive(). </parameters> <return> %TRUE if keepalive is active, %FALSE otherwise. -Since: 2.22 </return> </function> @@ -9937,6 +9576,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <description> Finishes an async connect operation. See g_socket_client_connect_to_service_async() +Since: 2.22 </description> <parameters> @@ -9956,7 +9596,27 @@ ignore. </parameters> <return> a #GSocketConnection on success, %NULL on error. -Since: 2.22 +</return> +</function> + +<function name="g_output_stream_is_closing"> +<description> +Checks if an output stream is being closed. This can be +used inside e.g. a flush implementation to see if the +flush (or other i/o operation) is called from within +the closing operation. + +Since: 2.24 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GOutputStream. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @stream is being closed. %FALSE otherwise. + </return> </function> @@ -9985,6 +9645,7 @@ will be returned. To be notified when data is available, wait for the On error -1 is returned and @error is set accordingly. +Since: 2.22 </description> <parameters> @@ -10012,27 +9673,28 @@ bytes long). </parameters> <return> Number of bytes read, or -1 on error -Since: 2.22 </return> </function> -<function name="g_file_io_stream_get_etag"> +<function name="g_file_info_get_attribute_int64"> <description> -Gets the entity tag for the file when it has been written. -This must be called after the stream has been written -and closed, as the etag can change while writing. +Gets a signed 64-bit integer contained within the attribute. If the +attribute does not contain an signed 64-bit integer, or is invalid, +0 will be returned. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GFileIOStream. +<parameter name="info"> +<parameter_description> a #GFileInfo. +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> a file attribute key. </parameter_description> </parameter> </parameters> -<return> the entity tag for the stream. - -Since: 2.22 +<return> a signed 64-bit integer from the attribute. </return> </function> @@ -10040,6 +9702,7 @@ Since: 2.22 <description> Gets @address's path. +Since: 2.22 </description> <parameters> @@ -10050,26 +9713,88 @@ Gets @address's path. </parameters> <return> %TRUE if the address is abstract, %FALSE otherwise +</return> +</function> + +<function name="g_socket_connect"> +<description> +Connect the socket to the specified remote address. + +For connection oriented socket this generally means we attempt to make +a connection to the @address. For a connection-less socket it sets +the default address for g_socket_send() and discards all incoming datagrams +from other sources. + +Generally connection oriented sockets can only connect once, but +connection-less sockets can connect multiple times to change the +default address. + +If the connect call needs to do network I/O it will block, unless +non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned +and the user can be notified of the connection finishing by waiting +for the G_IO_OUT condition. The result of the connection can then be +checked with g_socket_check_connect_result(). + Since: 2.22 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="address"> +<parameter_description> a #GSocketAddress specifying the remote address. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a %GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if connected, %FALSE on error. + </return> </function> -<function name="g_io_extension_get_name"> +<function name="g_seekable_truncate"> <description> -Gets the name under which @extension was registered. +Truncates a stream with a given #offset. -Note that the same type may be registered as extension -for multiple extension points, under different names. +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 an +operation was partially finished when the operation was cancelled the +partial result will be returned, without an error. </description> <parameters> -<parameter name="extension"> -<parameter_description> a #GIOExtension +<parameter name="seekable"> +<parameter_description> a #GSeekable. +</parameter_description> +</parameter> +<parameter name="offset"> +<parameter_description> a #goffset. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return> the name of @extension. +<return> %TRUE if successful. If an error +has occurred, this function will return %FALSE and set @error +appropriately if present. </return> </function> @@ -10113,6 +9838,7 @@ On error -1 is returned and @error is set accordingly. <description> Finishes ejecting a drive. +Deprecated: 2.22: Use g_drive_eject_with_operation_finish() instead. </description> <parameters> @@ -10132,20 +9858,12 @@ Finishes ejecting a drive. <return> %TRUE if the drive has been ejected successfully, %FALSE otherwise. -Deprecated: 2.22: Use g_drive_eject_with_operation_finish() instead. </return> </function> -<function name="g_socket_set_blocking"> +<function name="g_socket_get_socket_type"> <description> -Sets the blocking mode of the socket. In blocking mode -all operations block until they succeed or there is an error. In -non-blocking mode all functions return results immediately or -with a %G_IO_ERROR_WOULD_BLOCK error. - -All sockets are created in blocking mode. However, note that the -platform level socket is always non-blocking, and blocking mode -is a GSocket level feature. +Gets the socket type of the socket. Since: 2.22 @@ -10155,12 +9873,10 @@ Since: 2.22 <parameter_description> a #GSocket. </parameter_description> </parameter> -<parameter name="blocking"> -<parameter_description> Whether to use blocking I/O or not. -</parameter_description> -</parameter> </parameters> -<return></return> +<return> a #GSocketType + +</return> </function> <function name="g_buffered_input_stream_get_buffer_size"> @@ -10181,7 +9897,21 @@ Gets the size of the input buffer. <function name="g_unix_fd_list_peek_fds"> <description> -Returns: an array of file descriptors +Returns the array of file descriptors that is contained in this +object. + +After this call, the descriptors remain the property of @list. The +caller must not close them and must not free the array. The array is +valid only until @list is changed in any way. + +If @length is non-%NULL then it is set to the number of file +descriptors in the returned array. The returned array is also +terminated with -1. + +This function never returns %NULL. In case there are no file +descriptors contained in @list, an empty array is returned. + +Since: 2.24 </description> <parameters> @@ -10196,23 +9926,19 @@ Returns: an array of file descriptors </parameters> <return> an array of file descriptors -Since: 2.24 </return> </function> -<function name="g_file_load_partial_contents_async"> +<function name="g_file_create_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(). +Asynchronously creates a new file and returns an output stream for writing to it. +The file must not already exist. -Users of this function should be aware that @user_data is passed to -both the @read_more_callback and the @callback. +For more details, see g_file_create() which is +the synchronous version of this call. -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_create_finish() to get the result of the operation. </description> <parameters> @@ -10220,12 +9946,17 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="flags"> +<parameter_description> a set of #GFileCreateFlags. </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 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"> @@ -10233,30 +9964,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> the data to pass to the callback functions. +<parameter_description> the data to pass to callback function </parameter_description> </parameter> </parameters> <return></return> </function> -<function name="_fen_add"> -<description> -Won't hold a ref, we have a timout callback to clean unused fdata. -If there is no value for a key, add it and return it; else return the old -one. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_file_info_has_namespace"> <description> Checks if a file info structure has an attribute in the specified @name_space. +Since: 2.22 </description> <parameters> @@ -10272,7 +9992,6 @@ specified @name_space. <return> %TRUE if @Ginfo has an attribute in @name_space, %FALSE otherwise. -Since: 2.22 </return> </function> @@ -10281,6 +10000,7 @@ Since: 2.22 Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). +Since: 2.20 </description> <parameters> @@ -10291,7 +10011,6 @@ See g_app_info_delete(). </parameters> <return> %TRUE if @appinfo can be deleted -Since: 2.20 </return> </function> @@ -10333,74 +10052,88 @@ Since: 2.22 <return></return> </function> -<function name="g_srv_target_new"> +<function name="g_file_set_attribute"> <description> -Creates a new #GSrvTarget with the given parameters. +Sets an attribute in the file with attribute name @attribute to @value. -You should not need to use this; normally #GSrvTarget<!-- -->s are -created by #GResolver. +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> <parameters> -<parameter name="hostname"> -<parameter_description> the host that the service is running on +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="port"> -<parameter_description> the port that the service is running on +<parameter name="attribute"> +<parameter_description> a string containing the attribute's name. </parameter_description> </parameter> -<parameter name="priority"> -<parameter_description> the target's priority +<parameter name="type"> +<parameter_description> The type of the attribute </parameter_description> </parameter> -<parameter name="weight"> -<parameter_description> the target's weight +<parameter name="value_p"> +<parameter_description> a pointer to the value (or the pointer itself if the type is a pointer type) +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a set of #GFileQueryInfoFlags. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> a new #GSrvTarget. - -Since: 2.22 +<return> %TRUE if the attribute was set, %FALSE otherwise. </return> </function> -<function name="g_seekable_truncate"> +<function name="g_simple_async_report_error_in_idle"> <description> -Truncates a stream with a given #offset. - -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 an -operation was partially finished when the operation was cancelled the -partial result will be returned, without an error. - +Reports an error in an asynchronous function in an idle function by +directly setting the contents of the #GAsyncResult with the given error +information. </description> <parameters> -<parameter name="seekable"> -<parameter_description> a #GSeekable. +<parameter name="object"> +<parameter_description> a #GObject. </parameter_description> </parameter> -<parameter name="offset"> -<parameter_description> a #goffset. +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="user_data"> +<parameter_description> user data passed to @callback. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="domain"> +<parameter_description> a #GQuark containing the error domain (usually #G_IO_ERROR). +</parameter_description> +</parameter> +<parameter name="code"> +<parameter_description> a specific error code. +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> a formatted error reporting string. +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> a list of variables to fill in @format. </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> +<return></return> </function> <function name="g_file_icon_new"> @@ -10419,45 +10152,6 @@ Creates a new icon for a file. </return> </function> -<function name="g_file_unmount_mountable"> -<description> -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. - -Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead. - -</description> -<parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> flags affecting the operation -</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, or %NULL. -</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_socket_client_set_family"> <description> Sets the socket family of the socket client. @@ -10555,6 +10249,42 @@ Since: 2.22 <return></return> </function> +<function name="g_socket_listener_add_any_inet_port"> +<description> +Listens for TCP connections on any available port number for both +IPv6 and IPv4 (if each are available). + +This is useful if you need to have a socket for incoming connections +but don't care about the specific port number. + +@source_object will be passed out in the various calls +to accept to identify this particular source, which is +useful if you're listening on multiple addresses and do +different things depending on what address is connected to. + +Since: 2.24 + +</description> +<parameters> +<parameter name="listener"> +<parameter_description> a #GSocketListener +</parameter_description> +</parameter> +<parameter name="source_object"> +<parameter_description> Optional #GObject identifying this source +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. +</parameter_description> +</parameter> +</parameters> +<return> the port number, or 0 in case of failure. + +</return> +</function> + <function name="g_app_info_get_default_for_uri_scheme"> <description> Gets the default application for launching applications @@ -10628,6 +10358,7 @@ Finishes setting an attribute started in g_file_set_attributes_async(). Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog(). +Since: 2.22 </description> <parameters> @@ -10638,7 +10369,6 @@ see g_socket_set_listen_backlog(). </parameters> <return> the maximum number of pending connections. -Since: 2.22 </return> </function> @@ -10695,6 +10425,7 @@ finished <description> Gets @srv's protocol name (eg, "tcp"). +Since: 2.22 </description> <parameters> @@ -10705,29 +10436,53 @@ Gets @srv's protocol name (eg, "tcp"). </parameters> <return> @srv's protocol name -Since: 2.22 </return> </function> -<function name="g_unix_fd_message_new"> +<function name="g_file_unmount_mountable"> <description> -Creates a new #GUnixFDMessage containing an empty file descriptor -list. +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. + +Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead. </description> <parameters> +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags affecting the operation +</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, or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function +</parameter_description> +</parameter> </parameters> -<return> a new #GUnixFDMessage - -Since: 2.22 -</return> +<return></return> </function> <function name="g_network_address_get_port"> <description> Gets @addr's port number +Since: 2.22 </description> <parameters> @@ -10738,10 +10493,47 @@ Gets @addr's port number </parameters> <return> @addr's port (which may be 0) -Since: 2.22 </return> </function> +<function name="g_volume_eject_with_operation"> +<description> +Ejects a volume. This is an asynchronous operation, and is +finished by calling g_volume_eject_with_operation_finish() with the @volume +and #GAsyncResult data returned in the @callback. + +Since: 2.22 + +</description> +<parameters> +<parameter name="volume"> +<parameter_description> a #GVolume. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags affecting the unmount if required for eject +</parameter_description> +</parameter> +<parameter name="mount_operation"> +<parameter_description> a #GMountOperation or %NULL to avoid user interaction. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback, or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data passed to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_unix_fd_list_append"> <description> Adds a file descriptor to @list. @@ -10757,6 +10549,7 @@ The index of the file descriptor in the list is returned. If you use this index with g_unix_fd_list_get() then you will receive back a duplicated copy of the same file descriptor. +Since: 2.24 </description> <parameters> @@ -10776,35 +10569,6 @@ duplicated copy of the same file descriptor. <return> the index of the appended fd in case of success, else -1 (and @error is set) -Since: 2.24 -</return> -</function> - -<function name="g_data_output_stream_put_uint16"> -<description> -Puts an unsigned 16-bit integer into the output stream. - - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a #GDataOutputStream. -</parameter_description> -</parameter> -<parameter name="data"> -<parameter_description> a #guint16. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, %NULL to ignore. -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if @data was successfully added to the @stream. </return> </function> @@ -10869,24 +10633,6 @@ g_simple_async_result_complete_in_idle(). <return></return> </function> -<function name="g_srv_target_get_port"> -<description> -Gets @target's port - - -</description> -<parameters> -<parameter name="target"> -<parameter_description> a #GSrvTarget -</parameter_description> -</parameter> -</parameters> -<return> @target's port - -Since: 2.22 -</return> -</function> - <function name="g_drive_get_icon"> <description> Gets the icon for @drive. @@ -10960,27 +10706,24 @@ Checks if an input stream has pending actions. </return> </function> -<function name="g_themed_icon_append_name"> +<function name="g_inet_address_new_any"> <description> -Append a name to the list of icons from within @icon. +Creates a #GInetAddress for the "any" address (unassigned/"don't +care") for @family. -<note><para> -Note that doing so invalidates the hash computed by prior calls -to g_icon_hash(). -</para></note> +Since: 2.22 </description> <parameters> -<parameter name="icon"> -<parameter_description> a #GThemedIcon -</parameter_description> -</parameter> -<parameter name="iconname"> -<parameter_description> name of icon to append to list of icons from within @icon. +<parameter name="family"> +<parameter_description> the address family </parameter_description> </parameter> </parameters> -<return></return> +<return> a new #GInetAddress corresponding to the "any" address +for @family. + +</return> </function> <function name="g_socket_listener_add_socket"> @@ -10994,6 +10737,7 @@ to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to. +Since: 2.22 </description> <parameters> @@ -11016,47 +10760,6 @@ different things depending on what address is connected to. </parameters> <return> %TRUE on success, %FALSE on error. -Since: 2.22 -</return> -</function> - -<function name="g_file_info_set_attribute_byte_string"> -<description> -Sets the @attribute to contain the given @attr_value, -if possible. - -</description> -<parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. -</parameter_description> -</parameter> -<parameter name="attribute"> -<parameter_description> a file attribute key. -</parameter_description> -</parameter> -<parameter name="attr_value"> -<parameter_description> a byte string. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_socket_control_message_get_msg_type"> -<description> -Returns: an integer describing the type of control message - -</description> -<parameters> -<parameter name="message"> -<parameter_description> a #GSocketControlMessage -</parameter_description> -</parameter> -</parameters> -<return> an integer describing the type of control message - -Since: 2.22 </return> </function> @@ -11082,79 +10785,43 @@ not contain a byte string, %NULL will be returned. </return> </function> -<function name="g_buffered_output_stream_new_sized"> +<function name="g_data_input_stream_read_uint64"> <description> -Creates a new buffered output stream with a given buffer size. - - -</description> -<parameters> -<parameter name="base_stream"> -<parameter_description> a #GOutputStream. -</parameter_description> -</parameter> -<parameter name="size"> -<parameter_description> a #gsize. -</parameter_description> -</parameter> -</parameters> -<return> a #GOutputStream with an internal buffer set to @size. -</return> -</function> +Reads an unsigned 64-bit/8-byte value from @stream. -<function name="g_async_initable_new_async"> -<description> -Helper function for constructing #GAsyncInitiable object. This is -similar to g_object_new() but also initializes the object asynchronously. +In order to get the correct byte order for this read operation, +see g_data_stream_get_byte_order(). -When the initialization is finished, @callback will be called. You can -then call g_async_initable_new_finish() to get the new object and check -for any 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. -Since: 2.22 </description> <parameters> -<parameter name="object_type"> -<parameter_description> a #GType supporting #GAsyncInitable. -</parameter_description> -</parameter> -<parameter name="io_priority"> -<parameter_description> the <link linkend="io-priority">I/O priority</link> -of the operation. +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. </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 initialization is -finished -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function -</parameter_description> -</parameter> -<parameter name="first_property_name"> -<parameter_description> the name of the first property, or %NULL if no -properties -</parameter_description> -</parameter> -<parameter name="Varargs"> -<parameter_description> the value of the first property, followed by other property -value pairs, and ended by %NULL. +<parameter name="error"> +<parameter_description> #GError for error reporting. </parameter_description> </parameter> </parameters> -<return></return> +<return> an unsigned 64-bit/8-byte read from @stream or %0 if +an error occurred. +</return> </function> <function name="g_emblemed_icon_get_emblems"> <description> Gets the list of emblems for the @icon. +Since: 2.18 </description> <parameters> @@ -11165,29 +10832,49 @@ Gets the list of emblems for the @icon. </parameters> <return> a #GList of #GEmblem <!-- -->s that is owned by @emblemed -Since: 2.18 </return> </function> -<function name="g_emblem_new_with_origin"> +<function name="g_data_output_stream_put_uint64"> <description> -Creates a new emblem for @icon. +Puts an unsigned 64-bit integer into the stream. </description> <parameters> -<parameter name="icon"> -<parameter_description> a GIcon containing the icon. +<parameter name="stream"> +<parameter_description> a #GDataOutputStream. </parameter_description> </parameter> -<parameter name="origin"> -<parameter_description> a GEmblemOrigin enum defining the emblem's origin +<parameter name="data"> +<parameter_description> a #guint64. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> a new #GEmblem. +<return> %TRUE if @data was successfully added to the @stream. +</return> +</function> + +<function name="g_socket_client_new"> +<description> +Creates a new #GSocketClient with the default options. + +Since: 2.22 + +</description> +<parameters> +</parameters> +<return> a #GSocketClient. +Free the returned object with g_object_unref(). -Since: 2.18 </return> </function> @@ -11196,6 +10883,7 @@ Since: 2.18 Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). +Since: 2.22 </description> <parameters> @@ -11214,7 +10902,6 @@ by g_file_io_stream_query_info_async(). </parameters> <return> A #GFileInfo for the finished query. -Since: 2.22 </return> </function> @@ -11239,19 +10926,6 @@ add to a #GHashTable or similar data structure. </return> </function> -<function name="_ih_startup"> -<description> -Initializes the inotify backend. This must be called before -any other functions in this module. - - -</description> -<parameters> -</parameters> -<return> #TRUE if initialization succeeded, #FALSE otherwise -</return> -</function> - <function name="g_file_output_stream_query_info"> <description> Queries a file output stream for the given @attributes. @@ -11296,59 +10970,40 @@ be returned. </return> </function> -<function name="g_io_extension_get_type"> +<function name="g_io_extension_point_lookup"> <description> -Gets the type associated with @extension. +Looks up an existing extension point. </description> <parameters> -<parameter name="extension"> -<parameter_description> a #GIOExtension +<parameter name="name"> +<parameter_description> the name of the extension point </parameter_description> </parameter> </parameters> -<return> the type of @extension +<return> the #GIOExtensionPoint, or %NULL if there is no +registered extension point with the given name </return> </function> -<function name="g_file_info_get_etag"> +<function name="g_inet_address_new_loopback"> <description> -Gets the <link linkend="gfile-etag">entity tag</link> for a given -#GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE. +Creates a #GInetAddress for the loopback address for @family. +Since: 2.22 </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="family"> +<parameter_description> the address family </parameter_description> </parameter> </parameters> -<return> a string containing the value of the "etag:value" attribute. -</return> -</function> - -<function name="g_unix_mount_monitor_set_rate_limit"> -<description> -Sets the rate limit to which the @mount_monitor will report -consecutive change events to the mount and mount point entry files. - -Since: 2.18 +<return> a new #GInetAddress corresponding to the loopback address +for @family. -</description> -<parameters> -<parameter name="mount_monitor"> -<parameter_description> a #GUnixMountMonitor -</parameter_description> -</parameter> -<parameter name="limit_msec"> -<parameter_description> a integer with the limit in milliseconds to -poll for changes. -</parameter_description> -</parameter> -</parameters> -<return></return> +</return> </function> <function name="g_file_copy"> @@ -11515,6 +11170,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <description> Checks whether a socket is closed. +Since: 2.22 </description> <parameters> @@ -11525,7 +11181,6 @@ Checks whether a socket is closed. </parameters> <return> %TRUE if socket is closed, %FALSE otherwise -Since: 2.22 </return> </function> @@ -11548,15 +11203,19 @@ complete directory names, and not file names. <return></return> </function> -<function name="g_file_enumerator_next_files_finish"> +<function name="g_file_poll_mountable_finish"> <description> -Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). +Finishes a poll operation. See g_file_poll_mountable() for details. + +Finish an asynchronous poll operation that was polled +with g_file_poll_mountable(). +Since: 2.22 </description> <parameters> -<parameter name="enumerator"> -<parameter_description> a #GFileEnumerator. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> <parameter name="result"> @@ -11564,21 +11223,20 @@ Finishes the asynchronous operation started with g_file_enumerator_next_files_as </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> a #GList of #GFileInfo<!---->s. You must free the list with -g_list_free() and unref the infos with g_object_unref() when you're -done with them. +<return> %TRUE if the operation finished successfully. %FALSE +otherwise. + </return> </function> <function name="g_simple_async_report_gerror_in_idle"> <description> -Reports an error in an idle function. Similar to -g_simple_async_report_error_in_idle(), but takes a #GError rather +Reports an error in an idle function. Similar to +g_simple_async_report_error_in_idle(), but takes a #GError rather than building a new one. </description> @@ -11588,7 +11246,7 @@ than building a new one. </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback. +<parameter_description> a #GAsyncReadyCallback. </parameter_description> </parameter> <parameter name="user_data"> @@ -11620,18 +11278,35 @@ string should be freed when no longer needed. </return> </function> -<function name="g_filter_output_stream_get_close_base_stream"> +<function name="g_file_get_child_for_display_name"> <description> -Return value: %TRUE if the base stream will be closed. +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. + +This call does no blocking i/o. + </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GFilterOutputStream. +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="display_name"> +<parameter_description> string to a possible child. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError. </parameter_description> </parameter> </parameters> -<return> %TRUE if the base stream will be closed. +<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> @@ -11639,6 +11314,7 @@ Return value: %TRUE if the base stream will be closed. <description> Creates a new #GUnixFDMessage containing @list. +Since: 2.24 </description> <parameters> @@ -11649,7 +11325,53 @@ Creates a new #GUnixFDMessage containing @list. </parameters> <return> a new #GUnixFDMessage -Since: 2.24 +</return> +</function> + +<function name="g_volume_get_activation_root"> +<description> +Gets the activation root for a #GVolume if it is known ahead of +mount time. Returns %NULL otherwise. If not %NULL and if @volume +is mounted, then the result of g_mount_get_root() on the +#GMount object obtained from g_volume_get_mount() will always +either be equal or a prefix of what this function returns. In +other words, in code + +<programlisting> +GMount *mount; +GFile *mount_root +GFile *volume_activation_root; + +mount = g_volume_get_mount (volume); /* mounted, so never NULL */ +mount_root = g_mount_get_root (mount); +volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */ +</programlisting> + +then the expression + +<programlisting> +(g_file_has_prefix (volume_activation_root, mount_root) || + g_file_equal (volume_activation_root, mount_root)) +</programlisting> + +will always be %TRUE. + +Activation roots are typically used in #GVolumeMonitor +implementations to find the underlying mount to shadow, see +g_mount_is_shadowed() for more details. + +Since: 2.18 + +</description> +<parameters> +<parameter name="volume"> +<parameter_description> a #GVolume +</parameter_description> +</parameter> +</parameters> +<return> the activation root of @volume or %NULL. Use +g_object_unref() to free. + </return> </function> @@ -11732,13 +11454,13 @@ Creates a new #GSocketService with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). +Since: 2.22 </description> <parameters> </parameters> <return> a new #GSocketService. -Since: 2.22 </return> </function> @@ -11768,6 +11490,7 @@ As well as reading the fd this also reads a single byte from the stream, as this is required for fd passing to work on some implementations. +Since: 2.22 </description> <parameters> @@ -11786,7 +11509,6 @@ implementations. </parameters> <return> a file descriptor on success, -1 on error. -Since: 2.22 </return> </function> @@ -11856,6 +11578,7 @@ string (although in general abstract names need not be zero terminated and can have embedded nuls). All bytes after @path_len up to the max size of an abstract unix domain name is filled with zero bytes. +Since: 2.22 </description> <parameters> @@ -11870,7 +11593,6 @@ of an abstract unix domain name is filled with zero bytes. </parameters> <return> a new #GUnixSocketAddress -Since: 2.22 </return> </function> @@ -11945,6 +11667,7 @@ of message and if so deserialize it into a #GSocketControlMessage. If there is no implementation for this kind of control message, %NULL will be returned. +Since: 2.22 </description> <parameters> @@ -11967,7 +11690,6 @@ will be returned. </parameters> <return> the deserialized message or %NULL -Since: 2.22 </return> </function> @@ -11975,6 +11697,7 @@ Since: 2.22 <description> Gets the socket family of the socket. +Since: 2.22 </description> <parameters> @@ -11985,39 +11708,6 @@ Gets the socket family of the socket. </parameters> <return> a #GSocketFamily -Since: 2.22 -</return> -</function> - -<function name="g_filter_input_stream_get_base_stream"> -<description> -Gets the base stream for the filter stream. - - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a #GFilterInputStream. -</parameter_description> -</parameter> -</parameters> -<return> a #GInputStream. -</return> -</function> - -<function name="g_unix_mount_point_get_fs_type"> -<description> -Gets the file system type for the mount point. - - -</description> -<parameters> -<parameter name="mount_point"> -<parameter_description> a #GUnixMountPoint. -</parameter_description> -</parameter> -</parameters> -<return> a string containing the file system type. </return> </function> @@ -12058,20 +11748,31 @@ Removes all cases of @attribute from @info if it exists. <return></return> </function> -<function name="g_file_info_get_sort_order"> +<function name="g_drive_eject_with_operation_finish"> <description> -Gets the value of the sort_order attribute from the #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. +Finishes ejecting a drive. If any errors occurred during the operation, +@error will be set to contain the errors and %FALSE will be returned. +Since: 2.22 </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return> a #gint32 containing the value of the "standard::sort_order" attribute. +<return> %TRUE if the drive was successfully ejected. %FALSE otherwise. + </return> </function> @@ -12081,6 +11782,7 @@ Gets the socket type of the socket client. See g_socket_client_set_socket_type() for details. +Since: 2.22 </description> <parameters> @@ -12091,69 +11793,115 @@ See g_socket_client_set_socket_type() for details. </parameters> <return> a #GSocketFamily -Since: 2.22 </return> </function> -<function name="g_app_info_get_executable"> +<function name="g_socket_listener_accept"> <description> -Gets the executable's name for the installed application. +Blocks waiting for a client to connect to any of the sockets added +to the listener. Returns a #GSocketConnection for the socket that was +accepted. +If @source_object is not %NULL it will be filled out with the source +object specified when the corresponding socket or address was added +to the listener. + +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. + +Since: 2.22 </description> <parameters> -<parameter name="appinfo"> -<parameter_description> a #GAppInfo +<parameter name="listener"> +<parameter_description> a #GSocketListener +</parameter_description> +</parameter> +<parameter name="source_object"> +<parameter_description> location where #GObject pointer will be stored, or %NULL +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> a string containing the @appinfo's application -binaries name +<return> a #GSocketConnection on success, %NULL on error. + </return> </function> -<function name="g_file_get_child_for_display_name"> +<function name="g_async_initable_new_async"> <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. +Helper function for constructing #GAsyncInitiable object. This is +similar to g_object_new() but also initializes the object asynchronously. -This call does no blocking i/o. +When the initialization is finished, @callback will be called. You can +then call g_async_initable_new_finish() to get the new object and check +for any errors. +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="object_type"> +<parameter_description> a #GType supporting #GAsyncInitable. </parameter_description> </parameter> -<parameter name="display_name"> -<parameter_description> string to a possible child. +<parameter name="io_priority"> +<parameter_description> the <link linkend="io-priority">I/O priority</link> +of the operation. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> #GError. +<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 initialization is +finished +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function +</parameter_description> +</parameter> +<parameter name="first_property_name"> +<parameter_description> the name of the first property, or %NULL if no +properties +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the value of the first property, followed by other property +value pairs, and ended by %NULL. </parameter_description> </parameter> </parameters> -<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> +<return></return> </function> -<function name="GUnixInputStream"> +<function name="g_desktop_app_info_get_filename"> <description> -Whether to close the file descriptor when the stream is closed. +When @info was created from a known filename, return it. In some +situations such as the #GDesktopAppInfo returned from +g_desktop_app_info_new_from_keyfile(), this function will return %NULL. -Since: 2.20 +Since: 2.24 </description> <parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> </parameters> -<return></return> +<return> The full path to the file for @info, or %NULL if not known. +</return> </function> <function name="g_file_info_get_attribute_string"> @@ -12178,35 +11926,6 @@ not contain a string, %NULL will be returned. </return> </function> -<function name="g_simple_async_result_new"> -<description> -Creates a #GSimpleAsyncResult. - - -</description> -<parameters> -<parameter name="source_object"> -<parameter_description> a #GObject the asynchronous function was called with, -or %NULL. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback. -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> user data passed to @callback. -</parameter_description> -</parameter> -<parameter name="source_tag"> -<parameter_description> the asynchronous function. -</parameter_description> -</parameter> -</parameters> -<return> a #GSimpleAsyncResult. -</return> -</function> - <function name="g_content_type_equals"> <description> Compares two content types for equality. @@ -12247,31 +11966,36 @@ to the given size. <return></return> </function> -<function name="g_file_eject_mountable_finish"> +<function name="g_simple_async_result_is_valid"> <description> -Finishes an asynchronous eject operation started by -g_file_eject_mountable(). +Ensures that the data passed to the _finish function of an async +operation is consistent. Three checks are performed. + +First, @result is checked to ensure that it is really a +#GSimpleAsyncResult. Second, @source is checked to ensure that it +matches the source object of @result. Third, @source_tag is +checked to ensure that it is equal to the source_tag argument given +to g_simple_async_result_new() (which, by convention, is a pointer +to the _async function corresponding to the _finish function from +which this function is called). </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="result"> +<parameter_description> the #GAsyncResult passed to the _finish function. </parameter_description> </parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. +<parameter name="source"> +<parameter_description> the #GObject passed to the _finish function. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="source_tag"> +<parameter_description> the asynchronous function. </parameter_description> </parameter> </parameters> -<return> %TRUE if the @file was ejected successfully. %FALSE -otherwise. - -Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead. +<return> #TRUE if all checks passed or #FALSE if any failed. </return> </function> @@ -12308,14 +12032,23 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="GFileIcon"> +<function name="g_inet_address_to_string"> <description> -The file containing the icon. +Converts @address to string form. + +Since: 2.22 </description> <parameters> +<parameter name="address"> +<parameter_description> a #GInetAddress +</parameter_description> +</parameter> </parameters> -<return></return> +<return> a representation of @address as a string, which should be +freed after use. + +</return> </function> <function name="g_socket_bind"> @@ -12338,6 +12071,7 @@ fully cleaned-up by the kernel. Failing to set this flag on a server socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if the server program is stopped and then immediately restarted.) +Since: 2.22 </description> <parameters> @@ -12360,7 +12094,6 @@ the server program is stopped and then immediately restarted.) </parameters> <return> %TRUE on success, %FALSE on error. -Since: 2.22 </return> </function> @@ -12446,6 +12179,7 @@ As well as sending the fd this also writes a single byte to the stream, as this is required for fd passing to work on some implementations. +Since: 2.22 </description> <parameters> @@ -12468,7 +12202,6 @@ implementations. </parameters> <return> a %TRUE on success, %NULL on error. -Since: 2.22 </return> </function> @@ -12506,6 +12239,7 @@ If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. +Since: 2.22 </description> <parameters> @@ -12525,7 +12259,22 @@ a value from #GResolverError. If the operation was cancelled, <return> a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. -Since: 2.22 +</return> +</function> + +<function name="g_unix_mount_point_get_fs_type"> +<description> +Gets the file system type for the mount point. + + +</description> +<parameters> +<parameter name="mount_point"> +<parameter_description> a #GUnixMountPoint. +</parameter_description> +</parameter> +</parameters> +<return> a string containing the file system type. </return> </function> @@ -12549,7 +12298,13 @@ while on win32 it is "*". <function name="g_socket_get_fd"> <description> -Returns: the file descriptor of the socket. +Returns the underlying OS socket object. On unix this +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. + +Since: 2.22 </description> <parameters> @@ -12560,7 +12315,6 @@ Returns: the file descriptor of the socket. </parameters> <return> the file descriptor of the socket. -Since: 2.22 </return> </function> @@ -12647,55 +12401,68 @@ of the request. <return></return> </function> -<function name="g_unix_mount_guess_can_eject"> +<function name="g_data_output_stream_set_byte_order"> <description> -Guesses whether a Unix mount can be ejected. - +Sets the byte order of the data output stream to @order. </description> <parameters> -<parameter name="mount_entry"> -<parameter_description> a #GUnixMountEntry +<parameter name="stream"> +<parameter_description> a #GDataOutputStream. +</parameter_description> +</parameter> +<parameter name="order"> +<parameter_description> a %GDataStreamByteOrder. </parameter_description> </parameter> </parameters> -<return> %TRUE if @mount_entry is deemed to be ejectable. -</return> +<return></return> </function> -<function name="g_socket_control_message_get_size"> +<function name="g_data_input_stream_set_byte_order"> <description> -Returns: The number of bytes required. +This function sets the byte order for the given @stream. All subsequent +reads from the @stream will be read in the given @order. + </description> <parameters> -<parameter name="message"> -<parameter_description> a #GSocketControlMessage +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. +</parameter_description> +</parameter> +<parameter name="order"> +<parameter_description> a #GDataStreamByteOrder to set. </parameter_description> </parameter> </parameters> -<return> The number of bytes required. - -Since: 2.22 -</return> +<return></return> </function> -<function name="g_inet_address_to_string"> +<function name="g_drive_stop_finish"> <description> -Converts @address to string form. +Finishes stopping a drive. +Since: 2.22 </description> <parameters> -<parameter name="address"> -<parameter_description> a #GInetAddress +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> a representation of @address as a string, which should be -freed after use. +<return> %TRUE if the drive has been stopped successfully, +%FALSE otherwise. -Since: 2.22 </return> </function> @@ -12739,35 +12506,20 @@ Sets a default choice for the mount operation. <return></return> </function> -<function name="g_data_input_stream_read_int64"> +<function name="g_mount_operation_get_anonymous"> <description> -Reads a 64-bit/8-byte value from @stream. - -In order to get the correct byte order for this read operation, -see g_data_stream_get_byte_order() and g_data_stream_set_byte_order(). - -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. +Check to see whether the mount operation is being used +for an anonymous user. </description> <parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting. +<parameter name="op"> +<parameter_description> a #GMountOperation. </parameter_description> </parameter> </parameters> -<return> a signed 64-bit/8-byte value read from @stream or %0 if -an error occurred. +<return> %TRUE if mount operation is anonymous. </return> </function> @@ -12833,19 +12585,22 @@ by g_file_output_stream_query_info_async(). </return> </function> -<function name="g_simple_async_result_get_op_res_gpointer"> +<function name="g_socket_is_connected"> <description> -Gets a pointer result as returned by the asynchronous function. +Check whether the socket is connected. This is only useful for +connection-oriented sockets. +Since: 2.22 </description> <parameters> -<parameter name="simple"> -<parameter_description> a #GSimpleAsyncResult. +<parameter name="socket"> +<parameter_description> a #GSocket. </parameter_description> </parameter> </parameters> -<return> a pointer from the result. +<return> %TRUE if socket is connected, %FALSE otherwise. + </return> </function> @@ -12874,6 +12629,7 @@ If you are planning to connect to the service, it is usually easier to create a #GNetworkService and use its #GSocketConnectable interface. +Since: 2.22 </description> <parameters> @@ -12906,7 +12662,6 @@ interface. free each of the targets and the list when you are done with it. (You can use g_resolver_free_targets() to do this.) -Since: 2.22 </return> </function> @@ -13000,17 +12755,6 @@ Frees a unix mount point. <return></return> </function> -<function name="GInetSocketAddress"> -<description> -An IPv4 or IPv6 socket address, corresponding to a <type>struct -sockaddr_in</type> or <type>struct sockaddr_in6</type>. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_drive_start"> <description> Asynchronously starts a drive. @@ -13075,6 +12819,7 @@ 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 </description> <parameters> @@ -13098,45 +12843,67 @@ rather than just opening for reading or writing. <return> a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> -<function name="g_file_read_async"> +<function name="g_socket_listener_add_address"> <description> -Asynchronously opens @file for reading. +Creates a socket of type @type and protocol @protocol, binds +it to @address and adds it to the set of sockets we're accepting +sockets from. -For more details, see g_file_read() which is -the synchronous version of this call. +Note that adding an IPv6 address, depending on the platform, +may or may not result in a listener that also accepts IPv4 +connections. For more determinstic behaviour, see +g_socket_listener_add_inet_port(). -When the operation is finished, @callback will be called. You can then call -g_file_read_finish() to get the result of the operation. +@source_object will be passed out in the various calls +to accept to identify this particular source, which is +useful if you're listening on multiple addresses and do +different things depending on what address is connected to. + +If successful and @effective_address is non-%NULL then it will +be set to the address that the binding actually occured at. This +is helpful for determining the port number that was used for when +requesting a binding to port 0 (ie: "any port"). This address, if +requested, belongs to the caller and must be freed. + +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile +<parameter name="listener"> +<parameter_description> a #GSocketListener </parameter_description> </parameter> -<parameter name="io_priority"> -<parameter_description> the <link linkend="io-priority">I/O priority</link> -of the request. +<parameter name="address"> +<parameter_description> a #GSocketAddress </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="type"> +<parameter_description> a #GSocketType </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied +<parameter name="protocol"> +<parameter_description> a #GSocketProtocol </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function +<parameter name="source_object"> +<parameter_description> Optional #GObject identifying this source +</parameter_description> +</parameter> +<parameter name="effective_address"> +<parameter_description> location to store the address that was bound to, or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE on success, %FALSE on error. + +</return> </function> <function name="g_data_input_stream_read_int32"> @@ -13171,6 +12938,24 @@ an error occurred. </return> </function> +<function name="g_emblem_get_origin"> +<description> +Gets the origin of the emblem. + +Since: 2.18 + +</description> +<parameters> +<parameter name="emblem"> +<parameter_description> a #GEmblem +</parameter_description> +</parameter> +</parameters> +<return> the origin of the emblem + +</return> +</function> + <function name="g_file_info_set_display_name"> <description> Sets the display name for the current #GFileInfo. @@ -13216,49 +13001,46 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="g_socket_receive_from"> +<function name="g_file_mount_enclosing_volume"> <description> -Receive data (up to @size bytes) from a socket. - -If @address is non-%NULL then @address will be set equal to the -source address of the received packet. -@address is owned by the caller. +Starts a @mount_operation, mounting the volume that contains the file @location. -See g_socket_receive() for additional information. +When this operation has completed, @callback will be called 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. </description> <parameters> -<parameter name="socket"> -<parameter_description> a #GSocket +<parameter name="location"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="address"> -<parameter_description> a pointer to a #GSocketAddress pointer, or %NULL +<parameter name="flags"> +<parameter_description> flags affecting the operation </parameter_description> </parameter> -<parameter name="buffer"> -<parameter_description> a buffer to read data into (which should be at least @size -bytes long). +<parameter name="mount_operation"> +<parameter_description> a #GMountOperation or %NULL to avoid user interaction. </parameter_description> </parameter> -<parameter name="size"> -<parameter_description> the number of bytes you want to read from the socket +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> a %GCancellable or %NULL +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting, or %NULL to ignore. +<parameter name="user_data"> +<parameter_description> the data to pass to callback function </parameter_description> </parameter> </parameters> -<return> Number of bytes read, or -1 on error - -Since: 2.22 -</return> +<return></return> </function> <function name="g_seekable_can_seek"> @@ -13282,6 +13064,7 @@ Tests if the stream supports the #GSeekableIface. Gets the value of a stringv attribute. If the attribute does not contain a stringv, %NULL will be returned. +Since: 2.22 </description> <parameters> @@ -13297,7 +13080,6 @@ not contain a stringv, %NULL will be returned. <return> the contents of the @attribute value as a stringv, or %NULL otherwise. Do not free. -Since: 2.22 </return> </function> @@ -13326,7 +13108,48 @@ if possible. <function name="g_file_replace"> <description> -Returns: a #GFileOutputStream or %NULL on error. +Returns an output stream for overwriting the file, possibly +creating a backup copy of the file first. If the file doesn't exist, +it will be created. + +This will try to replace the file in the safest way possible so +that any errors during the writing will not affect an already +existing copy of the file. For instance, for local files it +may write to a temporary file and then atomically rename over +the destination when the stream is closed. + +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 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 +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. + </description> <parameters> @@ -13373,37 +13196,21 @@ Creates a new mount operation. </return> </function> -<function name="g_file_monitor_directory"> +<function name="g_inet_address_get_is_mc_org_local"> <description> -Obtains a directory monitor for the given file. -This may fail if directory monitoring is not supported. - -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. +Tests whether @address is an organization-local multicast address. +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> a set of #GFileMonitorFlags. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL. +<parameter name="address"> +<parameter_description> a #GInetAddress </parameter_description> </parameter> </parameters> -<return> a #GFileMonitor for the given @file, or %NULL on error. -Free the returned object with g_object_unref(). +<return> %TRUE if @address is an organization-local multicast address. + </return> </function> @@ -13446,36 +13253,6 @@ all keys in the unix namespace.</entry></row> </return> </function> -<function name="GCharsetConverter"> -<description> -Conversions between character sets. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_io_modules_load_all_in_directory"> -<description> -Loads all the modules in the specified directory. - - -</description> -<parameters> -<parameter name="dirname"> -<parameter_description> pathname for a directory containing modules to load. -</parameter_description> -</parameter> -</parameters> -<return> a list of #GIOModules loaded from the directory, -All the modules are loaded into memory, if you want to -unload them (enabling on-demand loading) you must call -g_type_module_unuse() on all the modules. Free the list -with g_list_free(). -</return> -</function> - <function name="g_socket_condition_check"> <description> Checks on the readiness of @socket to perform operations. @@ -13488,6 +13265,7 @@ these conditions will always be set in the output if they are true. This call never blocks. +Since: 2.22 </description> <parameters> @@ -13502,7 +13280,6 @@ This call never blocks. </parameters> <return> the @GIOCondition mask of the current state -Since: 2.22 </return> </function> @@ -13513,6 +13290,7 @@ this to the user, you should use g_hostname_is_ascii_encoded() to check if it contains encoded Unicode segments, and use g_hostname_to_unicode() to convert it if it does.) +Since: 2.22 </description> <parameters> @@ -13523,7 +13301,6 @@ g_hostname_to_unicode() to convert it if it does.) </parameters> <return> @target's hostname -Since: 2.22 </return> </function> @@ -13649,53 +13426,28 @@ extension point, the existing #GIOExtension object is returned. </return> </function> -<function name="GResolver"> -<description> -Emitted when the resolver notices that the system resolver -configuration has changed. - -</description> -<parameters> -<parameter name="resolver"> -<parameter_description> a #GResolver -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_unix_mount_is_readonly"> +<function name="g_file_attribute_matcher_enumerate_next"> <description> -Checks if a unix mount is mounted read only. +Gets the next matched attribute from a #GFileAttributeMatcher. </description> <parameters> -<parameter name="mount_entry"> -<parameter_description> a #GUnixMount. +<parameter name="matcher"> +<parameter_description> a #GFileAttributeMatcher. </parameter_description> </parameter> </parameters> -<return> %TRUE if @mount_entry is read only. +<return> a string containing the next attribute or %NULL if +no more attribute exist. </return> </function> -<function name="GUnixOutputStream"> -<description> -Whether to close the file descriptor when the stream is closed. - -Since: 2.20 - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_inet_address_new_from_string"> <description> Parses @string as an IP address and creates a new #GInetAddress. +Since: 2.22 </description> <parameters> @@ -13707,7 +13459,6 @@ Parses @string as an IP address and creates a new #GInetAddress. <return> a new #GInetAddress corresponding to @string, or %NULL if @string could not be parsed. -Since: 2.22 </return> </function> @@ -13732,61 +13483,49 @@ Gets the attribute type for an attribute key. </return> </function> -<function name="g_file_find_enclosing_mount_finish"> +<function name="g_file_attribute_info_list_lookup"> <description> -Finishes an asynchronous find mount request. -See g_file_find_enclosing_mount_async(). +Gets the file attribute with the name @name from @list. </description> <parameters> -<parameter name="file"> -<parameter_description> a #GFile -</parameter_description> -</parameter> -<parameter name="res"> -<parameter_description> a #GAsyncResult +<parameter name="list"> +<parameter_description> a #GFileAttributeInfoList. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError +<parameter name="name"> +<parameter_description> the name of the attribute to lookup. </parameter_description> </parameter> </parameters> -<return> #GMount for given @file or %NULL on error. -Free the returned object with g_object_unref(). +<return> a #GFileAttributeInfo for the @name, or %NULL if an +attribute isn't found. </return> </function> -<function name="g_inet_socket_address_get_port"> +<function name="g_app_info_get_id"> <description> -Gets @address's port. +Gets the ID of an application. An id is a string that +identifies the application. The exact format of the id is +platform dependent. For instance, on Unix this is the +desktop file id from the xdg menu specification. + +Note that the returned ID may be %NULL, depending on how +the @appinfo has been constructed. </description> <parameters> -<parameter name="address"> -<parameter_description> a #GInetSocketAddress +<parameter name="appinfo"> +<parameter_description> a #GAppInfo. </parameter_description> </parameter> </parameters> -<return> the port for @address - -Since: 2.22 +<return> a string containing the application's ID. </return> </function> -<function name="GMountOperation"> -<description> -The index of the user's choice when a question is asked during the -mount operation. See the #GMountOperation::ask-question signal. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_mount_eject_with_operation"> <description> Ejects a mount. This is an asynchronous operation, and is @@ -13899,6 +13638,25 @@ Appends @data to data that can be read from the input stream <return></return> </function> +<function name="g_io_stream_get_output_stream"> +<description> +Gets the output stream for this object. This is used for +writing. + +Since: 2.22 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GIOStream +</parameter_description> +</parameter> +</parameters> +<return> a #GOutputStream, owned by the #GIOStream. Do not free. + +</return> +</function> + <function name="g_content_type_get_description"> <description> Gets the human readable description of the content type. @@ -13965,6 +13723,7 @@ or %NULL if the entity tag is not needed <description> Tests whether @address is a multicast address. +Since: 2.22 </description> <parameters> @@ -13975,7 +13734,6 @@ Tests whether @address is a multicast address. </parameters> <return> %TRUE if @address is a multicast address. -Since: 2.22 </return> </function> @@ -14007,22 +13765,55 @@ Puts a signed 64-bit integer into the stream. </return> </function> -<function name="g_inet_socket_address_get_address"> +<function name="g_output_stream_close"> <description> -Gets @address's #GInetAddress. +Closes the stream, releasing resources related to it. + +Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. +Closing a stream multiple times will not return an error. + +Closing a stream will automatically flush any outstanding buffers in the +stream. + +Streams will be automatically closed when the last reference +is dropped, but you might want to call this function to make sure +resources are released as early as possible. + +Some streams might keep the backing store of the stream (e.g. a file descriptor) +open after the stream is closed. See the documentation for the individual +stream for details. + +On failure the first error that happened will be reported, but the close +operation will finish as much as possible. A stream that failed to +close will still return %G_IO_ERROR_CLOSED for all operations. Still, it +is important to check and report the error to the user, otherwise +there might be a loss of data as all data might not be written. + +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. +Cancelling a close will still leave the stream closed, but there some streams +can use a faster close that doesn't block to e.g. check errors. On +cancellation (as with any error) there is no guarantee that all written +data will reach the target. </description> <parameters> -<parameter name="address"> -<parameter_description> a #GInetSocketAddress +<parameter name="stream"> +<parameter_description> A #GOutputStream. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional cancellable object +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> location to store the error occuring, or %NULL to ignore </parameter_description> </parameter> </parameters> -<return> the #GInetAddress for @address, which must be -g_object_ref()'d if it will be stored - -Since: 2.22 +<return> %TRUE on success, %FALSE on failure </return> </function> @@ -14095,6 +13886,7 @@ appropriately if present. <description> Creates a #GSocketAddressEnumerator for @connectable. +Since: 2.22 </description> <parameters> @@ -14105,95 +13897,52 @@ Creates a #GSocketAddressEnumerator for @connectable. </parameters> <return> a new #GSocketAddressEnumerator. -Since: 2.22 </return> </function> -<function name="g_emblemed_icon_get_icon"> +<function name="g_unix_input_stream_get_fd"> <description> -Gets the main icon for @emblemed. +Return the UNIX file descriptor that the stream reads from. +Since: 2.20 </description> <parameters> -<parameter name="emblemed"> -<parameter_description> a #GEmblemedIcon +<parameter name="stream"> +<parameter_description> a #GUnixInputStream </parameter_description> </parameter> </parameters> -<return> a #GIcon that is owned by @emblemed +<return> The file descriptor of @stream -Since: 2.18 </return> </function> -<function name="GSrvTarget"> -<description> -A single target host/port that a network service is running on. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_file_replace_contents_async"> +<function name="g_socket_client_connect_finish"> <description> -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 -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. +Finishes an async connect operation. See g_socket_client_connect_async() -If @make_backup is %TRUE, this function will attempt to -make a backup of @file. +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="contents"> -<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> -</parameter> -<parameter name="etag"> -<parameter_description> a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL -</parameter_description> -</parameter> -<parameter name="make_backup"> -<parameter_description> %TRUE if a backup should be created. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> a set of #GFileCreateFlags. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="client"> +<parameter_description> a #GSocketClient. </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied +<parameter name="result"> +<parameter_description> a #GAsyncResult. </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GSocketConnection on success, %NULL on error. + +</return> </function> <function name="g_volume_monitor_get_volume_for_uuid"> @@ -14274,6 +14023,7 @@ In general, @host_and_port is expected to be provided by the user (allowing them to give the hostname, and a port overide if necessary) and @default_port is expected to be provided by the application. +Since: 2.22 </description> <parameters> @@ -14292,7 +14042,6 @@ and @default_port is expected to be provided by the application. </parameters> <return> the new #GNetworkAddress, or %NULL on error -Since: 2.22 </return> </function> @@ -14312,6 +14061,7 @@ 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 </description> <parameters> @@ -14331,7 +14081,6 @@ just opening for reading or writing. <return> #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -14352,6 +14101,7 @@ 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. +Since: 2.22 </description> <parameters> @@ -14374,48 +14124,29 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameters> <return> a #GSocket on success, %NULL on error. -Since: 2.22 </return> </function> -<function name="g_unix_mount_guess_icon"> -<description> -Guesses the icon of a Unix mount. - - -</description> -<parameters> -<parameter name="mount_entry"> -<parameter_description> a #GUnixMountEntry -</parameter_description> -</parameter> -</parameters> -<return> a #GIcon -</return> -</function> - -<function name="g_socket_address_get_family"> +<function name="g_file_attribute_matcher_unref"> <description> -Gets the socket family type of @address. +Unreferences @matcher. If the reference count falls below 1, +the @matcher is automatically freed. </description> <parameters> -<parameter name="address"> -<parameter_description> a #GSocketAddress +<parameter name="matcher"> +<parameter_description> a #GFileAttributeMatcher. </parameter_description> </parameter> </parameters> -<return> the socket family type of @address. - -Since: 2.22 -</return> +<return></return> </function> -<function name="g_file_monitor"> +<function name="g_file_set_attribute_int32"> <description> -Obtains a file or directory monitor for the given file, depending -on the type of the file. +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 @@ -14425,15 +14156,23 @@ 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> +</parameter> +<parameter name="value"> +<parameter_description> a #gint32 containing the attribute's new value. </parameter_description> </parameter> <parameter name="flags"> -<parameter_description> a set of #GFileMonitorFlags +<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"> @@ -14441,67 +14180,47 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> </parameters> -<return> a #GFileMonitor for the given @file, or %NULL on error. -Free the returned object with g_object_unref(). - -Since: 2.18 +<return> %TRUE if the @attribute was successfully set to @value +in the @file, %FALSE otherwise. </return> </function> -<function name="g_simple_async_result_get_op_res_gssize"> +<function name="g_unix_mount_at"> <description> -Gets a gssize from the asynchronous result. +Gets a #GUnixMountEntry for a given mount path. If @time_read +is set, it will be filled with a unix timestamp for checking +if the mounts have changed since with g_unix_mounts_changed_since(). </description> <parameters> -<parameter name="simple"> -<parameter_description> a #GSimpleAsyncResult. +<parameter name="mount_path"> +<parameter_description> path for a possible unix mount. +</parameter_description> +</parameter> +<parameter name="time_read"> +<parameter_description> guint64 to contain a timestamp. </parameter_description> </parameter> </parameters> -<return> a gssize returned from the asynchronous function. +<return> a #GUnixMount. </return> </function> -<function name="g_simple_async_report_error_in_idle"> +<function name="g_simple_async_result_get_op_res_gssize"> <description> -Reports an error in an asynchronous function in an idle function by -directly setting the contents of the #GAsyncResult with the given error -information. +Gets a gssize from the asynchronous result. + </description> <parameters> -<parameter name="object"> -<parameter_description> a #GObject. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback. -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> user data passed to @callback. -</parameter_description> -</parameter> -<parameter name="domain"> -<parameter_description> a #GQuark containing the error domain (usually #G_IO_ERROR). -</parameter_description> -</parameter> -<parameter name="code"> -<parameter_description> a specific error code. -</parameter_description> -</parameter> -<parameter name="format"> -<parameter_description> a formatted error reporting string. -</parameter_description> -</parameter> -<parameter name="Varargs"> -<parameter_description> a list of variables to fill in @format. +<parameter name="simple"> +<parameter_description> a #GSimpleAsyncResult. </parameter_description> </parameter> </parameters> -<return></return> +<return> a gssize returned from the asynchronous function. +</return> </function> <function name="g_file_append_to_async"> @@ -14557,21 +14276,31 @@ Gets the default #GVfs for the system. </return> </function> -<function name="g_drive_can_start_degraded"> +<function name="g_file_mount_mountable_finish"> <description> -Checks if a drive can be started degraded. +Finishes a mount operation. See g_file_mount_mountable() for details. + +Finish an asynchronous mount operation that was started +with g_file_mount_mountable(). </description> <parameters> -<parameter name="drive"> -<parameter_description> a #GDrive. +<parameter name="file"> +<parameter_description> input #GFile. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> %TRUE if the @drive can be started degraded, %FALSE otherwise. - -Since: 2.22 +<return> a #GFile or %NULL on error. +Free the returned object with g_object_unref(). </return> </function> @@ -14637,6 +14366,7 @@ context</link>). Gets the input stream for this object. This is used for reading. +Since: 2.22 </description> <parameters> @@ -14647,7 +14377,6 @@ for reading. </parameters> <return> a #GInputStream, owned by the #GIOStream. Do not free. -Since: 2.22 </return> </function> @@ -14676,6 +14405,7 @@ Gets the length of @address's path. For details, see g_unix_socket_address_get_path(). +Since: 2.22 </description> <parameters> @@ -14686,7 +14416,6 @@ For details, see g_unix_socket_address_get_path(). </parameters> <return> the length of the path -Since: 2.22 </return> </function> @@ -14843,7 +14572,13 @@ Deprecated: 2.22: Use g_mount_unmount_with_operation() instead. <function name="g_file_query_default_handler"> <description> -Returns: a #GAppInfo if the handle was found, %NULL if there were errors. +Returns the #GAppInfo that is registered as the default +application to handle the file specified by @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. + </description> <parameters> @@ -14865,28 +14600,6 @@ When you are done with it, release it with g_object_unref() </return> </function> -<function name="g_unix_mount_at"> -<description> -Gets a #GUnixMountEntry for a given mount path. If @time_read -is set, it will be filled with a unix timestamp for checking -if the mounts have changed since with g_unix_mounts_changed_since(). - - -</description> -<parameters> -<parameter name="mount_path"> -<parameter_description> path for a possible unix mount. -</parameter_description> -</parameter> -<parameter name="time_read"> -<parameter_description> guint64 to contain a timestamp. -</parameter_description> -</parameter> -</parameters> -<return> a #GUnixMount. -</return> -</function> - <function name="g_app_info_supports_files"> <description> Checks if the application accepts files as arguments. @@ -14903,48 +14616,6 @@ Checks if the application accepts files as arguments. </return> </function> -<function name="g_file_set_attribute_int32"> -<description> -Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. -If @attribute is of a different type, this operation will fail. - -If @cancellable is not %NULL, then the operation can be cancelled by -triggering the cancellable object from another thread. If the operation -was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - - -</description> -<parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="attribute"> -<parameter_description> a string containing the attribute's name. -</parameter_description> -</parameter> -<parameter name="value"> -<parameter_description> a #gint32 containing the attribute's new value. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> a #GFileQueryInfoFlags. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if the @attribute was successfully set to @value -in the @file, %FALSE otherwise. -</return> -</function> - <function name="g_unix_mount_point_is_user_mountable"> <description> Checks if a unix mount point is mountable by the user. @@ -14977,22 +14648,23 @@ Checks if the application supports reading files and directories from URIs. </return> </function> -<function name="g_zlib_decompressor_new"> +<function name="g_file_info_set_icon"> <description> -Creates a new #GZlibDecompressor. - +Sets the icon for a given #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_ICON. </description> <parameters> -<parameter name="format"> -<parameter_description> The format to use for the compressed data +<parameter name="info"> +<parameter_description> a #GFileInfo. +</parameter_description> +</parameter> +<parameter name="icon"> +<parameter_description> a #GIcon. </parameter_description> </parameter> </parameters> -<return> a new #GZlibDecompressor - -Since: 2.24 -</return> +<return></return> </function> <function name="g_file_attribute_info_list_dup"> @@ -15015,6 +14687,7 @@ Makes a duplicate of a file attribute info list. <description> Checks if a drive can be stopped. +Since: 2.22 </description> <parameters> @@ -15025,54 +14698,43 @@ Checks if a drive can be stopped. </parameters> <return> %TRUE if the @drive can be stopped, %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_file_input_stream_query_info_async"> +<function name="g_app_info_get_commandline"> <description> -Queries the stream information asynchronously. -When the operation is finished @callback will be called. -You can then call g_file_input_stream_query_info_finish() -to get the result of the operation. - -For the synchronous version of this function, -see g_file_input_stream_query_info(). - -If @cancellable is not %NULL, then the operation can be cancelled by -triggering the cancellable object from another thread. If the operation -was cancelled, the error %G_IO_ERROR_CANCELLED will be set +Gets the commandline with which the application will be +started. +Since: 2.20 </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GFileInputStream. -</parameter_description> -</parameter> -<parameter name="attributes"> -<parameter_description> a file 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> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> callback to call when the request is satisfied +<parameter name="appinfo"> +<parameter_description> a #GAppInfo </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function +</parameters> +<return> a string containing the @appinfo's commandline, +or %NULL if this information is not available + +</return> +</function> + +<function name="g_seekable_can_truncate"> +<description> +Tests if the stream can be truncated. + + +</description> +<parameters> +<parameter name="seekable"> +<parameter_description> a #GSeekable. </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE if the stream can be truncated, %FALSE otherwise. +</return> </function> <function name="g_socket_new_from_fd"> @@ -15085,6 +14747,7 @@ all properties should work. Note that the file descriptor will be set to non-blocking mode, independent on the blocking mode of the #GSocket. +Since: 2.22 </description> <parameters> @@ -15100,7 +14763,22 @@ mode of the #GSocket. <return> a #GSocket or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 +</return> +</function> + +<function name="g_seekable_tell"> +<description> +Tells the current position within the stream. + + +</description> +<parameters> +<parameter name="seekable"> +<parameter_description> a #GSeekable. +</parameter_description> +</parameter> +</parameters> +<return> the offset from the beginning of the buffer. </return> </function> @@ -15108,6 +14786,7 @@ Since: 2.22 <description> Gets the number of fallbacks that @converter has applied so far. +Since: 2.24 </description> <parameters> @@ -15118,7 +14797,6 @@ Gets the number of fallbacks that @converter has applied so far. </parameters> <return> the number of fallbacks that @converter has applied -Since: 2.24 </return> </function> @@ -15158,6 +14836,7 @@ cancelled. See #GCancellable::cancelled for details on how to use this. +Since: 2.22 </description> <parameters> @@ -15181,7 +14860,6 @@ See #GCancellable::cancelled for details on how to use this. <return> The id of the signal handler or 0 if @cancellable has already been cancelled. -Since: 2.22 </return> </function> @@ -15189,6 +14867,7 @@ Since: 2.22 <description> Creates a new emblem for @icon. +Since: 2.18 </description> <parameters> @@ -15199,7 +14878,6 @@ Creates a new emblem for @icon. </parameters> <return> a new #GEmblem. -Since: 2.18 </return> </function> @@ -15208,6 +14886,7 @@ Since: 2.18 Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking(). +Since: 2.22 </description> <parameters> @@ -15218,7 +14897,6 @@ see g_socket_set_blocking(). </parameters> <return> %TRUE if blocking I/O is used, %FALSE otherwise. -Since: 2.22 </return> </function> @@ -15227,6 +14905,7 @@ Since: 2.22 Creates a new #GSocketConnectable for connecting to the given @hostname and @port. +Since: 2.22 </description> <parameters> @@ -15241,7 +14920,6 @@ Creates a new #GSocketConnectable for connecting to the given </parameters> <return> the new #GNetworkAddress -Since: 2.22 </return> </function> @@ -15475,112 +15153,72 @@ with a buffer set to @size. </return> </function> -<function name="g_file_query_settable_attributes"> +<function name="g_buffered_input_stream_fill_finish"> <description> -Obtain the list of settable attributes for the file. +Finishes an asynchronous read. -Returns: a #GFileAttributeInfoList describing the settable attributes. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="stream"> +<parameter_description> a #GBufferedInputStream. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="result"> +<parameter_description> a #GAsyncResult. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter_description> a #GError. </parameter_description> </parameter> </parameters> -<return> a #GFileAttributeInfoList describing the settable attributes. -When you are done with it, release it with g_file_attribute_info_list_unref() +<return> a #gssize of the read stream, or %-1 on an error. </return> </function> -<function name="g_io_error_from_errno"> +<function name="g_socket_receive_from"> <description> -Converts errno.h error codes into GIO error codes. - - -</description> -<parameters> -<parameter name="err_no"> -<parameter_description> Error number as defined in errno.h. -</parameter_description> -</parameter> -</parameters> -<return> #GIOErrorEnum value for the given errno.h error number. -</return> -</function> +Receive data (up to @size bytes) from a socket. -<function name="g_file_mount_enclosing_volume"> -<description> -Starts a @mount_operation, mounting the volume that contains the file @location. +If @address is non-%NULL then @address will be set equal to the +source address of the received packet. +@address is owned by the caller. -When this operation has completed, @callback will be called with -@user_user data, and the operation can be finalized with -g_file_mount_enclosing_volume_finish(). +See g_socket_receive() for additional information. -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. +Since: 2.22 </description> <parameters> -<parameter name="location"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="flags"> -<parameter_description> flags affecting the operation -</parameter_description> -</parameter> -<parameter name="mount_operation"> -<parameter_description> a #GMountOperation or %NULL to avoid user interaction. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="socket"> +<parameter_description> a #GSocket </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. +<parameter name="address"> +<parameter_description> a pointer to a #GSocketAddress pointer, or %NULL </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function +<parameter name="buffer"> +<parameter_description> a buffer to read data into (which should be at least @size +bytes long). </parameter_description> </parameter> -</parameters> -<return></return> -</function> - -<function name="g_data_input_stream_read_byte"> -<description> -Reads an unsigned 8-bit/1-byte value from @stream. - - -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. +<parameter name="size"> +<parameter_description> the number of bytes you want to read from the socket </parameter_description> </parameter> <parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter_description> a %GCancellable or %NULL </parameter_description> </parameter> <parameter name="error"> -<parameter_description> #GError for error reporting. +<parameter_description> #GError for error reporting, or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> an unsigned 8-bit/1-byte value read from the @stream or %0 -if an error occurred. +<return> Number of bytes read, or -1 on error + </return> </function> @@ -15725,20 +15363,35 @@ Gets the name for a file. </return> </function> -<function name="g_mount_operation_get_anonymous"> +<function name="g_data_input_stream_read_int64"> <description> -Check to see whether the mount operation is being used -for an anonymous user. +Reads a 64-bit/8-byte value from @stream. + +In order to get the correct byte order for this read operation, +see g_data_stream_get_byte_order() and g_data_stream_set_byte_order(). + +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </description> <parameters> -<parameter name="op"> -<parameter_description> a #GMountOperation. +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting. </parameter_description> </parameter> </parameters> -<return> %TRUE if mount operation is anonymous. +<return> a signed 64-bit/8-byte value read from @stream or %0 if +an error occurred. </return> </function> @@ -15762,30 +15415,78 @@ g_object_unref() when no longer needed. </return> </function> -<function name="g_socket_is_connected"> +<function name="g_simple_async_result_get_op_res_gpointer"> <description> -Check whether the socket is connected. This is only useful for -connection-oriented sockets. +Gets a pointer result as returned by the asynchronous function. </description> <parameters> -<parameter name="socket"> -<parameter_description> a #GSocket. +<parameter name="simple"> +<parameter_description> a #GSimpleAsyncResult. </parameter_description> </parameter> </parameters> -<return> %TRUE if socket is connected, %FALSE otherwise. +<return> a pointer from the result. +</return> +</function> -Since: 2.22 +<function name="g_data_output_stream_put_byte"> +<description> +Puts a byte into the output stream. + + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GDataOutputStream. +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> a #guchar. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @data was successfully added to the @stream. </return> </function> +<function name="g_unix_mount_monitor_set_rate_limit"> +<description> +Sets the rate limit to which the @mount_monitor will report +consecutive change events to the mount and mount point entry files. + +Since: 2.18 + +</description> +<parameters> +<parameter name="mount_monitor"> +<parameter_description> a #GUnixMountMonitor +</parameter_description> +</parameter> +<parameter name="limit_msec"> +<parameter_description> a integer with the limit in milliseconds to +poll for changes. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_get_remote_address"> <description> Try to get the remove address of a connected socket. This is only useful for connection oriented sockets that have been connected. +Since: 2.22 </description> <parameters> @@ -15801,7 +15502,6 @@ useful for connection oriented sockets that have been connected. <return> a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -15883,21 +15583,21 @@ an error occurred. </return> </function> -<function name="g_unix_input_stream_get_fd"> +<function name="g_emblemed_icon_get_icon"> <description> -Return the UNIX file descriptor that the stream reads from. +Gets the main icon for @emblemed. +Since: 2.18 </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GUnixInputStream +<parameter name="emblemed"> +<parameter_description> a #GEmblemedIcon </parameter_description> </parameter> </parameters> -<return> The file descriptor of @stream +<return> a #GIcon that is owned by @emblemed -Since: 2.20 </return> </function> @@ -15907,6 +15607,7 @@ Gets the socket family of the socket client. See g_socket_client_set_family() for details. +Since: 2.22 </description> <parameters> @@ -15917,7 +15618,6 @@ See g_socket_client_set_family() for details. </parameters> <return> a #GSocketFamily -Since: 2.22 </return> </function> @@ -15942,20 +15642,33 @@ when no longer needed. </return> </function> -<function name="g_file_attribute_matcher_unref"> +<function name="g_simple_async_result_new"> <description> -Unreferences @matcher. If the reference count falls below 1, -the @matcher is automatically freed. +Creates a #GSimpleAsyncResult. </description> <parameters> -<parameter name="matcher"> -<parameter_description> a #GFileAttributeMatcher. +<parameter name="source_object"> +<parameter_description> a #GObject the asynchronous function was called with, +or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data passed to @callback. +</parameter_description> +</parameter> +<parameter name="source_tag"> +<parameter_description> the asynchronous function. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GSimpleAsyncResult. +</return> </function> <function name="g_content_type_get_mime_type"> @@ -15978,24 +15691,47 @@ Gets the mime-type for the content type. If one is registered <description> Gets the #GResolver Error Quark. +Since: 2.22 </description> <parameters> </parameters> <return> a #GQuark. -Since: 2.22 </return> </function> -<function name="g_input_stream_clear_pending"> +<function name="g_file_find_enclosing_mount_async"> <description> -Clears the pending flag on @stream. +Asynchronously gets the mount for the file. + +For more details, see g_file_find_enclosing_mount() which is +the synchronous version of this call. + +When the operation is finished, @callback will be called. You can then call +g_file_find_enclosing_mount_finish() to get the result of the operation. </description> <parameters> -<parameter name="stream"> -<parameter_description> input stream +<parameter name="file"> +<parameter_description> a #GFile +</parameter_description> +</parameter> +<parameter name="io_priority"> +<parameter_description> the <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> @@ -16086,6 +15822,36 @@ of the request. <return></return> </function> +<function name="g_themed_icon_new_with_default_fallbacks"> +<description> +Creates a new themed icon for @iconname, and all the names +that can be created by shortening @iconname at '-' characters. + +In the following example, @icon1 and @icon2 are equivalent: +|[ +const char *names[] = { +"gnome-dev-cdrom-audio", +"gnome-dev-cdrom", +"gnome-dev", +"gnome" +}; + +icon1 = g_themed_icon_new_from_names (names, 4); +icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); +]| + + +</description> +<parameters> +<parameter name="iconname"> +<parameter_description> a string containing an icon name +</parameter_description> +</parameter> +</parameters> +<return> a new #GThemedIcon. +</return> +</function> + <function name="g_mount_get_name"> <description> Gets the name of @mount. @@ -16168,6 +15934,7 @@ list available applications. Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. +Since: 2.22 </description> <parameters> @@ -16187,7 +15954,6 @@ ignore. </parameters> <return> %TRUE if the mount was successfully ejected. %FALSE otherwise. -Since: 2.22 </return> </function> @@ -16250,6 +16016,7 @@ very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. +Since: 2.22 </description> <parameters> @@ -16277,57 +16044,36 @@ On error -1 is returned and @error is set accordingly. <return> Number of bytes written (which may be less than @size), or -1 on error -Since: 2.22 </return> </function> -<function name="g_resolver_lookup_service_finish"> +<function name="g_file_get_basename"> <description> -Retrieves the result of a previous call to -g_resolver_lookup_service_async(). - -If the DNS resolution failed, @error (if non-%NULL) will be set to -a value from #GResolverError. If the operation was cancelled, -@error will be set to %G_IO_ERROR_CANCELLED. - +Gets the base name (the last component of the path) for a given #GFile. -</description> -<parameters> -<parameter name="resolver"> -<parameter_description> a #GResolver -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> the result passed to your #GAsyncReadyCallback -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> return location for a #GError, or %NULL -</parameter_description> -</parameter> -</parameters> -<return> a #GList of #GSrvTarget, or %NULL on error. See -g_resolver_lookup_service() for more details. +If called for the top level of a system (such as the filesystem root +or a uri like sftp://host/) it will return a single directory separator +(and on Windows, possibly a drive letter). -Since: 2.22 -</return> -</function> +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(). -<function name="g_volume_get_drive"> -<description> -Gets the drive for the @volume. +This call does no blocking i/o. </description> <parameters> -<parameter name="volume"> -<parameter_description> a #GVolume. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> </parameters> -<return> a #GDrive or %NULL if @volume is not associated with a drive. -The returned object should be unreffed with g_object_unref() -when no longer needed. +<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> @@ -16386,6 +16132,7 @@ if possible. Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). +Since: 2.22 </description> <parameters> @@ -16405,7 +16152,6 @@ g_file_open_readwrite_async(). <return> a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -16426,25 +16172,6 @@ Checks if the buffer automatically grows as data is added. </return> </function> -<function name="g_memory_output_stream_get_data"> -<description> -Gets any loaded data from the @ostream. - -Note that the returned pointer may become invalid on the next -write or truncate operation on the stream. - - -</description> -<parameters> -<parameter name="ostream"> -<parameter_description> a #GMemoryOutputStream -</parameter_description> -</parameter> -</parameters> -<return> pointer to the stream's data -</return> -</function> - <function name="g_cancellable_cancel"> <description> Will set @cancellable to cancelled, and will emit the @@ -16488,6 +16215,7 @@ The protocol id is passed directly to the operating system, so you can use protocols not listed in #GSocketProtocol if you know the protocol number used for it. +Since: 2.22 </description> <parameters> @@ -16511,37 +16239,38 @@ know the protocol number used for it. <return> a #GSocket or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> -<function name="g_file_get_basename"> +<function name="g_resolver_lookup_service_finish"> <description> -Gets the base name (the last component of the path) for a given #GFile. - -If called for the top level of a system (such as the filesystem root -or a uri like sftp://host/) it will return a single directory separator -(and on Windows, possibly a drive letter). - -The base name is a byte string (*not* UTF-8). It has no defined encoding -or rules other than it may not contain zero bytes. If you want to use -filenames in a user interface you should use the display name that you -can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME -attribute with g_file_query_info(). +Retrieves the result of a previous call to +g_resolver_lookup_service_async(). -This call does no blocking i/o. +If the DNS resolution failed, @error (if non-%NULL) will be set to +a value from #GResolverError. If the operation was cancelled, +@error will be set to %G_IO_ERROR_CANCELLED. +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="resolver"> +<parameter_description> a #GResolver +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> the result passed to your #GAsyncReadyCallback +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL </parameter_description> </parameter> </parameters> -<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> a #GList of #GSrvTarget, or %NULL on error. See +g_resolver_lookup_service() for more details. + </return> </function> @@ -16566,42 +16295,92 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="g_file_attribute_matcher_enumerate_next"> +<function name="g_unix_fd_message_append_fd"> <description> -Gets the next matched attribute from a #GFileAttributeMatcher. +Adds a file descriptor to @message. +The file descriptor is duplicated using dup(). You keep your copy +of the descriptor and the copy contained in @message will be closed +when @message is finalized. + +A possible cause of failure is exceeding the per-process or +system-wide file descriptor limit. + +Since: 2.22 </description> <parameters> -<parameter name="matcher"> -<parameter_description> a #GFileAttributeMatcher. +<parameter name="message"> +<parameter_description> a #GUnixFDMessage +</parameter_description> +</parameter> +<parameter name="fd"> +<parameter_description> a valid open file descriptor +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError pointer </parameter_description> </parameter> </parameters> -<return> a string containing the next attribute or %NULL if -no more attribute exist. +<return> %TRUE in case of success, else %FALSE (and @error is set) + </return> </function> -<function name="g_file_info_get_attribute_int64"> +<function name="g_volume_get_drive"> <description> -Gets a signed 64-bit integer contained within the attribute. If the -attribute does not contain an signed 64-bit integer, or is invalid, -0 will be returned. +Gets the drive for the @volume. </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="volume"> +<parameter_description> a #GVolume. </parameter_description> </parameter> -<parameter name="attribute"> -<parameter_description> a file attribute key. +</parameters> +<return> a #GDrive or %NULL if @volume is not associated with a drive. +The returned object should be unreffed with g_object_unref() +when no longer needed. +</return> +</function> + +<function name="g_converter_input_stream_get_converter"> +<description> +Gets the #GConverter that is used by @converter_stream. + +Since: 2.24 + +</description> +<parameters> +<parameter name="converter_stream"> +<parameter_description> a #GConverterInputStream </parameter_description> </parameter> </parameters> -<return> a signed 64-bit integer from the attribute. +<return> the converter of the converter input stream + +</return> +</function> + +<function name="g_file_io_stream_get_etag"> +<description> +Gets the entity tag for the file when it has been written. +This must be called after the stream has been written +and closed, as the etag can change while writing. + +Since: 2.22 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GFileIOStream. +</parameter_description> +</parameter> +</parameters> +<return> the entity tag for the stream. + </return> </function> @@ -16654,6 +16433,7 @@ simply the name (such as <literal>network-server</literal>). </para></listitem> </itemizedlist> +Since: 2.20 </description> <parameters> @@ -16665,7 +16445,6 @@ simply the name (such as <literal>network-server</literal>). <return> An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. -Since: 2.20 </return> </function> @@ -16743,6 +16522,11 @@ The other is for implementing a #GVolumeMonitor whose sole purpose is to return #GVolume objects representing entries in the users "favorite servers" list or similar. +Deprecated: 2.20: Instead of using this function, #GVolumeMonitor +implementations should instead create shadow mounts with the URI of +the mount they intend to adopt. See the proxy volume monitor in +gvfs for an example of this. Also see g_mount_is_shadowed(), +g_mount_shadow() and g_mount_unshadow() functions. </description> <parameters> @@ -16754,11 +16538,6 @@ is to return #GVolume objects representing entries in the users <return> the #GVolume object that is the parent for @mount or %NULL if no wants to adopt the #GMount. -Deprecated: 2.20: Instead of using this function, #GVolumeMonitor -implementations should instead create shadow mounts with the URI of -the mount they intend to adopt. See the proxy volume monitor in -gvfs for an example of this. Also see g_mount_is_shadowed(), -g_mount_shadow() and g_mount_unshadow() functions. </return> </function> @@ -16791,48 +16570,22 @@ sure resources are released as early as possible. </return> </function> -<function name="g_socket_connect"> +<function name="g_socket_control_message_get_msg_type"> <description> -Connect the socket to the specified remote address. - -For connection oriented socket this generally means we attempt to make -a connection to the @address. For a connection-less socket it sets -the default address for g_socket_send() and discards all incoming datagrams -from other sources. - -Generally connection oriented sockets can only connect once, but -connection-less sockets can connect multiple times to change the -default address. - -If the connect call needs to do network I/O it will block, unless -non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned -and the user can be notified of the connection finishing by waiting -for the G_IO_OUT condition. The result of the connection can then be -checked with g_socket_check_connect_result(). +Returns the protocol specific type of the control message. +For instance, for UNIX fd passing this would be SCM_RIGHTS. +Since: 2.22 </description> <parameters> -<parameter name="socket"> -<parameter_description> a #GSocket. -</parameter_description> -</parameter> -<parameter name="address"> -<parameter_description> a #GSocketAddress specifying the remote address. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> a %GCancellable or %NULL -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting, or %NULL to ignore. +<parameter name="message"> +<parameter_description> a #GSocketControlMessage </parameter_description> </parameter> </parameters> -<return> %TRUE if connected, %FALSE on error. +<return> an integer describing the type of control message -Since: 2.22 </return> </function> @@ -16898,117 +16651,117 @@ Checks if two icons are equal. </return> </function> -<function name="g_volume_should_automount"> -<description> -Returns: %TRUE if the volume should be automatically mounted. - -</description> -<parameters> -<parameter name="volume"> -<parameter_description> a #GVolume -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if the volume should be automatically mounted. -</return> -</function> - -<function name="g_seekable_tell"> +<function name="g_input_stream_skip_async"> <description> -Tells the current position within the stream. - +Request an asynchronous skip of @count bytes from the stream. +When the operation is finished @callback will be called. +You can then call g_input_stream_skip_finish() to get the result of the +operation. -</description> -<parameters> -<parameter name="seekable"> -<parameter_description> a #GSeekable. -</parameter_description> -</parameter> -</parameters> -<return> the offset from the beginning of the buffer. -</return> -</function> +During an async request no other sync and async calls are allowed, and will +result in %G_IO_ERROR_PENDING errors. -<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. +A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT 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. +On success, the number of bytes skipped will be passed to the +callback. It is not an error if this is not the same as the requested size, as it +can happen e.g. near the end of a file, but generally we try to skip +as many bytes as requested. Zero is returned on end of file +(or if @count is zero), but never otherwise. -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. +Any outstanding i/o request with higher priority (lower numerical value) will +be executed before an outstanding request with lower priority. Default +priority is %G_PRIORITY_DEFAULT. +The asyncronous methods have a default fallback that uses threads to implement +asynchronicity, so they are optional for inheriting classes. However, if you +override one you must override all. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="stream"> +<parameter_description> A #GInputStream. </parameter_description> </parameter> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="count"> +<parameter_description> the number of bytes that will be skipped from the stream </parameter_description> </parameter> -<parameter name="flags"> -<parameter_description> #GFileQueryInfoFlags +<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> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="callback"> +<parameter_description> callback 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> %TRUE if there was any error, %FALSE otherwise. -</return> +<return></return> </function> -<function name="g_simple_async_result_new_error"> +<function name="g_memory_output_stream_get_data"> <description> -Creates a new #GSimpleAsyncResult with a set error. +Gets any loaded data from the @ostream. + +Note that the returned pointer may become invalid on the next +write or truncate operation on the stream. </description> <parameters> -<parameter name="source_object"> -<parameter_description> a #GObject, or %NULL. -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback. +<parameter name="ostream"> +<parameter_description> a #GMemoryOutputStream </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> user data passed to @callback. +</parameters> +<return> pointer to the stream's data +</return> +</function> + +<function name="g_initable_new_valist"> +<description> +Helper function for constructing #GInitiable object. This is +similar to g_object_new_valist() but also initializes the object +and returns %NULL, setting an error on failure. + +Since: 2.22 + +</description> +<parameters> +<parameter name="object_type"> +<parameter_description> a #GType supporting #GInitable. </parameter_description> </parameter> -<parameter name="domain"> -<parameter_description> a #GQuark. +<parameter name="first_property_name"> +<parameter_description> the name of the first property, followed by +the value, and other property value pairs, and ended by %NULL. </parameter_description> </parameter> -<parameter name="code"> -<parameter_description> an error code. +<parameter name="var_args"> +<parameter_description> The var args list generated from @first_property_name. </parameter_description> </parameter> -<parameter name="format"> -<parameter_description> a string with format characters. +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="Varargs"> -<parameter_description> a list of values to insert into @format. +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return> a #GSimpleAsyncResult. +<return> a newly allocated #GObject, or %NULL on error + </return> </function> @@ -17023,6 +16776,7 @@ to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to. +Since: 2.22 </description> <parameters> @@ -17045,7 +16799,6 @@ different things depending on what address is connected to. </parameters> <return> %TRUE on success, %FALSE on error. -Since: 2.22 </return> </function> @@ -17069,6 +16822,7 @@ Gets the mount path for a unix mount. <description> Finishes an async accept operation. See g_socket_listener_accept_socket_async() +Since: 2.22 </description> <parameters> @@ -17092,7 +16846,6 @@ ignore. </parameters> <return> a #GSocket on success, %NULL on error. -Since: 2.22 </return> </function> @@ -17113,34 +16866,41 @@ or %NULL on error. </return> </function> -<function name="g_io_error_quark"> +<function name="g_file_read_async"> <description> -Gets the GIO Error Quark. - - -</description> -<parameters> -</parameters> -<return> a #GQuark. -</return> -</function> +Asynchronously opens @file for reading. -<function name="g_socket_get_socket_type"> -<description> -Gets the socket type of the socket. +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. </description> <parameters> -<parameter name="socket"> -<parameter_description> a #GSocket. +<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> a #GSocketType - -Since: 2.22 -</return> +<return></return> </function> <function name="g_socket_client_connect_to_host"> @@ -17235,6 +16995,7 @@ Creates a new #GInetAddress from the given @family and @bytes. @bytes should be 4 bytes for %G_INET_ADDRESS_IPV4 and 16 bytes for %G_INET_ADDRESS_IPV6. +Since: 2.22 </description> <parameters> @@ -17249,7 +17010,6 @@ Creates a new #GInetAddress from the given @family and @bytes. </parameters> <return> a new #GInetAddress corresponding to @family and @bytes. -Since: 2.22 </return> </function> @@ -17272,15 +17032,32 @@ g_unix_mounts_points_changed_since(). </return> </function> -<function name="g_file_attribute_info_list_unref"> +<function name="g_socket_listener_accept_socket_async"> <description> -Removes a reference from the given @list. If the reference count -falls to zero, the @list is deleted. +This is the asynchronous version of g_socket_listener_accept_socket(). + +When the operation is finished @callback will be +called. You can then call g_socket_listener_accept_socket_finish() +to get the result of the operation. + +Since: 2.22 </description> <parameters> -<parameter name="list"> -<parameter_description> The #GFileAttributeInfoList to unreference. +<parameter name="listener"> +<parameter_description> a #GSocketListener +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data for the callback </parameter_description> </parameter> </parameters> @@ -17298,6 +17075,7 @@ specification for more on x-content types. This is an synchronous operation and as such may block doing IO; see g_mount_guess_content_type() for the asynchronous version. +Since: 2.18 </description> <parameters> @@ -17323,7 +17101,6 @@ ignore <return> a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. -Since: 2.18 </return> </function> @@ -17332,6 +17109,7 @@ Since: 2.18 Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). +Since: 2.22 </description> <parameters> @@ -17352,57 +17130,62 @@ ignore. <return> %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. -Since: 2.22 </return> </function> -<function name="g_input_stream_skip_async"> +<function name="g_async_initable_init_async"> <description> -Request an asynchronous skip of @count bytes from the stream. -When the operation is finished @callback will be called. -You can then call g_input_stream_skip_finish() to get the result of the -operation. +Starts asynchronous initialization of the object implementing the +interface. This must be done before any real use of the object after +initial construction. If the object also implements #GInitable you can +optionally call g_initable_init() instead. -During an async request no other sync and async calls are allowed, and will -result in %G_IO_ERROR_PENDING errors. +When the initialization is finished, @callback will be called. You can +then call g_async_initable_init_finish() to get the result of the +initialization. -A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. +Implementations may also support cancellation. If @cancellable is not +%NULL, then initialization 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, and +the object doesn't support cancellable initialization, the error +%G_IO_ERROR_NOT_SUPPORTED will be returned. -On success, the number of bytes skipped will be passed to the -callback. It is not an error if this is not the same as the requested size, as it -can happen e.g. near the end of a file, but generally we try to skip -as many bytes as requested. Zero is returned on end of file -(or if @count is zero), but never otherwise. +If this function is not called, or returns with an error, then all +operations on the object should fail, generally returning the +error %G_IO_ERROR_NOT_INITIALIZED. -Any outstanding i/o request with higher priority (lower numerical value) will -be executed before an outstanding request with lower priority. Default -priority is %G_PRIORITY_DEFAULT. +Implementations of this method must be idempotent: i.e. multiple calls +to this function with the same argument should return the same results. +Only the first call initializes the object; further calls return the result +of the first call. This is so that it's safe to implement the singleton +pattern in the GObject constructor function. -The asyncronous methods have a default fallback that uses threads to implement -asynchronicity, so they are optional for inheriting classes. However, if you -override one you must override all. +For classes that also support the #GInitable interface, the default +implementation of this method will run the g_initable_init() function +in a thread, so if you want to support asynchronous initialization via +threads, just implement the #GAsyncInitable interface without overriding +any interface methods. + +Since: 2.22 </description> <parameters> -<parameter name="stream"> -<parameter_description> A #GInputStream. -</parameter_description> -</parameter> -<parameter name="count"> -<parameter_description> the number of bytes that will be skipped from the stream +<parameter name="initable"> +<parameter_description> a #GAsyncInitable. </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 operation. </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> callback 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"> @@ -17421,6 +17204,7 @@ during the operation, @error will be set to contain the errors and %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing. +Since: 2.18 </description> <parameters> @@ -17441,7 +17225,6 @@ ignore <return> a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. -Since: 2.18 </return> </function> @@ -17547,6 +17330,7 @@ errors that can happen due to races when you execute the operation. <description> Tests whether @address is the "any" address for its family. +Since: 2.22 </description> <parameters> @@ -17557,7 +17341,6 @@ Tests whether @address is the "any" address for its family. </parameters> <return> %TRUE if @address is the "any" address for its family. -Since: 2.22 </return> </function> @@ -17570,6 +17353,7 @@ may contain embedded zeros, and thus you should use g_unix_socket_address_get_path_len() to get the true length of this string. +Since: 2.22 </description> <parameters> @@ -17580,7 +17364,6 @@ of this string. </parameters> <return> the path for @address -Since: 2.22 </return> </function> @@ -17605,23 +17388,6 @@ Since: 2.20 <return></return> </function> -<function name="g_io_extension_ref_class"> -<description> -Gets a reference to the class for the type that is -associated with @extension. - - -</description> -<parameters> -<parameter name="extension"> -<parameter_description> a #GIOExtension -</parameter_description> -</parameter> -</parameters> -<return> the #GTypeClass for the type of @extension -</return> -</function> - <function name="g_app_info_get_default_for_type"> <description> Gets the #GAppInfo that corresponds to a given content type. @@ -17824,6 +17590,9 @@ Runs the asynchronous job in a separate thread and then calls g_simple_async_result_complete_in_idle() on @simple to return the result to the appropriate main loop. +Calling this function takes a reference to @simple for as long as +is needed to run the job and report its completion. + </description> <parameters> <parameter name="simple"> @@ -17839,21 +17608,28 @@ the result to the appropriate main loop. </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></return> </function> -<function name="g_file_load_partial_contents_finish"> +<function name="g_file_load_contents_async"> <description> -Finishes an asynchronous partial load operation that was started -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. +Starts an asynchronous load of the @file's contents. + +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 +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. </description> <parameters> @@ -17861,51 +17637,69 @@ needed. <parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="res"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="contents"> -<parameter_description> a location to place the contents of the file. -</parameter_description> -</parameter> -<parameter name="length"> -<parameter_description> a location to place the length of the contents of the file, -or %NULL if the length is not needed +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="etag_out"> -<parameter_description> a location to place the current entity tag for the file, -or %NULL if the entity tag is not needed +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="user_data"> +<parameter_description> the data to pass to callback function </parameter_description> </parameter> </parameters> -<return> %TRUE if the load was successful. If %FALSE and @error is -present, it will be set appropriately. -</return> +<return></return> </function> -<function name="g_inet_address_to_bytes"> +<function name="g_output_stream_write"> <description> -Gets the raw binary address data from @address. +Tries to write @count bytes from @buffer into the stream. Will block +during the operation. + +If count is zero returns zero and does nothing. A value of @count +larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. + +On success, the number of bytes written to the stream is returned. +It is not an error if this is not the same as the requested size, as it +can happen e.g. on a partial i/o error, or if there is not enough +storage in the stream. All writes either block until at least one byte +is written, so zero is never returned (unless @count is zero). + +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 an +operation was partially finished when the operation was cancelled the +partial result will be returned, without an error. + +On error -1 is returned and @error is set accordingly. </description> <parameters> -<parameter name="address"> -<parameter_description> a #GInetAddress +<parameter name="stream"> +<parameter_description> a #GOutputStream. +</parameter_description> +</parameter> +<parameter name="buffer"> +<parameter_description> the buffer containing the data to write. +</parameter_description> +</parameter> +<parameter name="count"> +<parameter_description> the number of bytes to write +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional cancellable object +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> location to store the error occuring, or %NULL to ignore </parameter_description> </parameter> </parameters> -<return> a pointer to an internal array of the bytes in @address, -which should not be modified, stored, or freed. The size of this -array can be gotten with g_inet_address_get_native_size(). - -Since: 2.22 +<return> Number of bytes written, or -1 on error </return> </function> @@ -17957,23 +17751,21 @@ written to the stream </return> </function> -<function name="g_file_get_path"> +<function name="g_vfs_get_supported_uri_schemes"> <description> -Gets the local pathname for #GFile, if one exists. - -This call does no blocking i/o. +Gets a list of URI schemes supported by @vfs. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="vfs"> +<parameter_description> a #GVfs. </parameter_description> </parameter> </parameters> -<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> a %NULL-terminated array of strings. +The returned array belongs to GIO and must +not be freed or modified. </return> </function> @@ -18011,45 +17803,72 @@ Free the returned object with g_object_unref(). </return> </function> -<function name="g_converter_input_stream_get_converter"> +<function name="g_file_output_stream_get_etag"> <description> -Gets the #GConverter that is used by @converter_stream. +Gets the entity tag for the file when it has been written. +This must be called after the stream has been written +and closed, as the etag can change while writing. </description> <parameters> -<parameter name="converter_stream"> -<parameter_description> a #GConverterInputStream +<parameter name="stream"> +<parameter_description> a #GFileOutputStream. </parameter_description> </parameter> </parameters> -<return> the converter of the converter input stream - -Since: 2.24 +<return> the entity tag for the stream. </return> </function> -<function name="g_file_output_stream_get_etag"> +<function name="g_input_stream_close"> <description> -Gets the entity tag for the file when it has been written. -This must be called after the stream has been written -and closed, as the etag can change while writing. +Closes the stream, releasing resources related to it. + +Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. +Closing a stream multiple times will not return an error. + +Streams will be automatically closed when the last reference +is dropped, but you might want to call this function to make sure +resources are released as early as possible. + +Some streams might keep the backing store of the stream (e.g. a file descriptor) +open after the stream is closed. See the documentation for the individual +stream for details. + +On failure the first error that happened will be reported, but the close +operation will finish as much as possible. A stream that failed to +close will still return %G_IO_ERROR_CLOSED for all operations. Still, it +is important to check and report the error to the user. + +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. +Cancelling a close will still leave the stream closed, but some streams +can use a faster close that doesn't block to e.g. check errors. </description> <parameters> <parameter name="stream"> -<parameter_description> a #GFileOutputStream. +<parameter_description> A #GInputStream. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> location to store the error occuring, or %NULL to ignore </parameter_description> </parameter> </parameters> -<return> the entity tag for the stream. +<return> %TRUE on success, %FALSE on failure </return> </function> <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 @@ -18126,6 +17945,7 @@ may be returned (if the native move operation isn't available). <description> Try to get the local address of a socket connection. +Since: 2.22 </description> <parameters> @@ -18141,7 +17961,6 @@ Try to get the local address of a socket connection. <return> a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -18149,6 +17968,7 @@ Since: 2.22 <description> Tests whether @address is a link-local multicast address. +Since: 2.22 </description> <parameters> @@ -18159,7 +17979,6 @@ Tests whether @address is a link-local multicast address. </parameters> <return> %TRUE if @address is a link-local multicast address. -Since: 2.22 </return> </function> @@ -18195,79 +18014,36 @@ Gets the edit name for a file. </return> </function> -<function name="g_file_set_attribute"> +<function name="g_srv_target_new"> <description> -Sets an attribute in the file with attribute name @attribute to @value. +Creates a new #GSrvTarget with the given parameters. -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. +You should not need to use this; normally #GSrvTarget<!-- -->s are +created by #GResolver. +Since: 2.22 </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. -</parameter_description> -</parameter> -<parameter name="attribute"> -<parameter_description> a string containing the attribute's name. -</parameter_description> -</parameter> -<parameter name="type"> -<parameter_description> The type of the attribute -</parameter_description> -</parameter> -<parameter name="value_p"> -<parameter_description> a pointer to the value (or the pointer itself if the type is a pointer type) +<parameter name="hostname"> +<parameter_description> the host that the service is running on </parameter_description> </parameter> -<parameter name="flags"> -<parameter_description> a set of #GFileQueryInfoFlags. +<parameter name="port"> +<parameter_description> the port that the service is running on </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="priority"> +<parameter_description> the target's priority </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL +<parameter name="weight"> +<parameter_description> the target's weight </parameter_description> </parameter> </parameters> -<return> %TRUE if the attribute was set, %FALSE otherwise. -</return> -</function> - -<function name="g_data_input_stream_read_uint64"> -<description> -Reads an unsigned 64-bit/8-byte value from @stream. - -In order to get the correct byte order for this read operation, -see g_data_stream_get_byte_order(). - -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. - +<return> a new #GSrvTarget. -</description> -<parameters> -<parameter name="stream"> -<parameter_description> a given #GDataInputStream. -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting. -</parameter_description> -</parameter> -</parameters> -<return> an unsigned 64-bit/8-byte read from @stream or %0 if -an error occurred. </return> </function> @@ -18471,6 +18247,7 @@ data is available, wait for the %G_IO_IN condition. On error -1 is returned and @error is set accordingly. +Since: 2.22 </description> <parameters> @@ -18515,7 +18292,6 @@ elements in @messages, or %NULL </parameters> <return> Number of bytes read, or -1 on error -Since: 2.22 </return> </function> @@ -18523,6 +18299,7 @@ Since: 2.22 <description> Copies @target +Since: 2.22 </description> <parameters> @@ -18533,7 +18310,6 @@ Copies @target </parameters> <return> a copy of @target -Since: 2.22 </return> </function> @@ -18541,6 +18317,7 @@ Since: 2.22 <description> Tests whether @address is a site-local multicast address. +Since: 2.22 </description> <parameters> @@ -18551,7 +18328,6 @@ Tests whether @address is a site-local multicast address. </parameters> <return> %TRUE if @address is a site-local multicast address. -Since: 2.22 </return> </function> @@ -18572,7 +18348,7 @@ a given destination. </parameter_description> </parameter> </parameters> -<return> %TRUE if the error was propegated to @dest. %FALSE otherwise. +<return> %TRUE if the error was propagated to @dest. %FALSE otherwise. </return> </function> @@ -18581,6 +18357,7 @@ a given destination. Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). +Since: 2.22 </description> <parameters> @@ -18600,23 +18377,9 @@ g_file_replace_readwrite_async(). <return> a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> -<function name="GInetAddress"> -<description> -Whether this is a site-local multicast address. -See g_inet_address_get_is_mc_site_local(). - -Since: 2.22 - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_app_launch_context_get_display"> <description> Gets the display string for the display. This is used to ensure new @@ -18660,6 +18423,32 @@ set to True. </return> </function> +<function name="g_io_modules_scan_all_in_directory"> +<description> +Scans all the modules in the specified directory, ensuring that +any extension point implemented by a module is registered. + +This may not actually load and initialize all the types in each +module, some modules may be lazily loaded and initialized when +an extension point it implementes is used with e.g. +g_io_extension_point_get_extensions() or +g_io_extension_point_get_extension_by_name(). + +If you need to guarantee that all types are loaded in all the modules, +use g_io_modules_scan_all_in_directory(). + +Since: 2.24 + +</description> +<parameters> +<parameter name="dirname"> +<parameter_description> pathname for a directory containing modules to scan. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_service_stop"> <description> Stops the service, i.e. stops accepting connections @@ -18685,6 +18474,7 @@ Since: 2.22 Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). +Since: 2.22 </description> <parameters> @@ -18704,7 +18494,6 @@ g_file_eject_mountable_with_operation(). <return> %TRUE if the @file was ejected successfully. %FALSE otherwise. -Since: 2.22 </return> </function> @@ -18776,6 +18565,7 @@ very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. +Since: 2.22 </description> <parameters> @@ -18820,7 +18610,6 @@ On error -1 is returned and @error is set accordingly. <return> Number of bytes written (which may be less than @size), or -1 on error -Since: 2.22 </return> </function> @@ -18885,37 +18674,6 @@ Checks if the VFS is active. </return> </function> -<function name="g_simple_async_result_set_error_va"> -<description> -Sets an error within the asynchronous result without a #GError. -Unless writing a binding, see g_simple_async_result_set_error(). - -</description> -<parameters> -<parameter name="simple"> -<parameter_description> a #GSimpleAsyncResult. -</parameter_description> -</parameter> -<parameter name="domain"> -<parameter_description> a #GQuark (usually #G_IO_ERROR). -</parameter_description> -</parameter> -<parameter name="code"> -<parameter_description> an error code. -</parameter_description> -</parameter> -<parameter name="format"> -<parameter_description> a formatted error reporting string. -</parameter_description> -</parameter> -<parameter name="args"> -<parameter_description> va_list of arguments. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_srv_target_free"> <description> Frees @target @@ -18996,43 +18754,6 @@ finished <return></return> </function> -<function name="g_socket_client_connect_to_service_async"> -<description> -This is the asynchronous version of -g_socket_client_connect_to_service(). - -Since: 2.22 - -</description> -<parameters> -<parameter name="client"> -<parameter_description> a #GSocketClient -</parameter_description> -</parameter> -<parameter name="domain"> -<parameter_description> a domain name -</parameter_description> -</parameter> -<parameter name="service"> -<parameter_description> the name of the service to connect to -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> a #GCancellable, or %NULL -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback -</parameter_description> -</parameter> -<parameter name="user_data"> -<parameter_description> user data for the callback -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_simple_async_result_new_from_error"> <description> Creates a #GSimpleAsyncResult from an error condition. @@ -19061,28 +18782,20 @@ Creates a #GSimpleAsyncResult from an error condition. </return> </function> -<function name="GThemedIcon"> +<function name="g_unix_mount_is_readonly"> <description> -Whether to use the default fallbacks found by shortening the icon name -at '-' characters. If the "names" array has more than one element, -ignores any past the first. +Checks if a unix mount is mounted read only. -For example, if the icon name was "gnome-dev-cdrom-audio", the array -would become -|[ -{ -"gnome-dev-cdrom-audio", -"gnome-dev-cdrom", -"gnome-dev", -"gnome", -NULL -}; -]| </description> <parameters> +<parameter name="mount_entry"> +<parameter_description> a #GUnixMount. +</parameter_description> +</parameter> </parameters> -<return></return> +<return> %TRUE if @mount_entry is read only. +</return> </function> <function name="g_content_type_guess_for_tree"> @@ -19098,6 +18811,7 @@ specification for more on x-content types. This function is useful in the implementation of g_mount_guess_content_type(). +Since: 2.18 </description> <parameters> @@ -19109,7 +18823,6 @@ This function is useful in the implementation of g_mount_guess_content_type(). <return> an %NULL-terminated array of zero or more content types, or %NULL. Free with g_strfreev() -Since: 2.18 </return> </function> @@ -19120,6 +18833,7 @@ Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). +Since: 2.22 </description> <parameters> @@ -19139,26 +18853,22 @@ with g_file_start_mountable(). <return> %TRUE if the operation finished successfully. %FALSE otherwise. -Since: 2.22 </return> </function> -<function name="g_unix_fd_list_get_length"> +<function name="g_mount_operation_get_domain"> <description> -Gets the length of @list (ie: the number of file descriptors -contained within). +Gets the domain of the mount operation. </description> <parameters> -<parameter name="list"> -<parameter_description> a #GUnixFDList +<parameter name="op"> +<parameter_description> a #GMountOperation. </parameter_description> </parameter> </parameters> -<return> the length of @list - -Since: 2.24 +<return> a string set to the domain. </return> </function> @@ -19223,47 +18933,37 @@ of the request. <return></return> </function> -<function name="g_drive_eject_with_operation_finish"> +<function name="g_file_info_get_sort_order"> <description> -Finishes ejecting a drive. If any errors occurred during the operation, -@error will be set to contain the errors and %FALSE will be returned. +Gets the value of the sort_order attribute from the #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. </description> <parameters> -<parameter name="drive"> -<parameter_description> a #GDrive. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="info"> +<parameter_description> a #GFileInfo. </parameter_description> </parameter> </parameters> -<return> %TRUE if the drive was successfully ejected. %FALSE otherwise. - -Since: 2.22 +<return> a #gint32 containing the value of the "standard::sort_order" attribute. </return> </function> -<function name="g_themed_icon_new"> +<function name="g_app_info_get_executable"> <description> -Creates a new themed icon for @iconname. +Gets the executable's name for the installed application. </description> <parameters> -<parameter name="iconname"> -<parameter_description> a string containing an icon name. +<parameter name="appinfo"> +<parameter_description> a #GAppInfo </parameter_description> </parameter> </parameters> -<return> a new #GThemedIcon. +<return> a string containing the @appinfo's application +binaries name </return> </function> @@ -19310,22 +19010,28 @@ present, it will be set appropriately. </return> </function> -<function name="g_file_get_uri"> +<function name="g_input_stream_read_finish"> <description> -Gets the URI for the @file. - -This call does no blocking i/o. +Finishes an asynchronous stream read operation. </description> <parameters> -<parameter name="file"> -<parameter_description> input #GFile. +<parameter name="stream"> +<parameter_description> a #GInputStream. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError location to store the error occuring, or %NULL to +ignore. </parameter_description> </parameter> </parameters> -<return> a string containing the #GFile's URI. -The returned string should be freed with g_free() when no longer needed. +<return> number of bytes read in, or -1 on error. </return> </function> @@ -19379,16 +19085,6 @@ g_object_unref() when no longer needed. </return> </function> -<function name="GZlibCompressor"> -<description> -Zlib decompression - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_buffered_input_stream_get_available"> <description> Gets the size of the available data within the stream. @@ -19405,33 +19101,6 @@ Gets the size of the available data within the stream. </return> </function> -<function name="g_drive_stop_finish"> -<description> -Finishes stopping a drive. - - -</description> -<parameters> -<parameter name="drive"> -<parameter_description> a #GDrive. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError, or %NULL -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if the drive has been stopped successfully, -%FALSE otherwise. - -Since: 2.22 -</return> -</function> - <function name="missing_remove"> <description> Unsafe, need lock fen_lock. @@ -19444,19 +19113,23 @@ Unsafe, need lock fen_lock. <function name="g_memory_output_stream_new"> <description> -Creates a new #GMemoryOutputStream. +Creates a new #GMemoryOutputStream. If @data is non-%NULL, the stream will use that for its internal storage. If @realloc_fn is non-%NULL, it will be used for resizing the internal -storage when necessary. To construct a fixed-size output stream, +storage when necessary. To construct a fixed-size output stream, pass %NULL as @realloc_fn. + |[ /* a stream that can grow */ stream = g_memory_output_stream_new (NULL, 0, realloc, free); +/* another stream that can grow */ +stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free); + /* a fixed-size stream */ data = malloc (200); -stream2 = g_memory_output_stream_new (data, 200, NULL, free); +stream3 = g_memory_output_stream_new (data, 200, NULL, free); ]| @@ -19466,18 +19139,18 @@ stream2 = g_memory_output_stream_new (data, 200, NULL, free); <parameter_description> pointer to a chunk of memory to use, or %NULL </parameter_description> </parameter> -<parameter name="len"> +<parameter name="size"> <parameter_description> the size of @data </parameter_description> </parameter> -<parameter name="realloc_fn"> -<parameter_description> a function with realloc() semantics to be called when -@data needs to be grown, or %NULL +<parameter name="realloc_function"> +<parameter_description> a function with realloc() semantics (like g_realloc()) +to be called when @data needs to be grown, or %NULL </parameter_description> </parameter> -<parameter name="destroy"> -<parameter_description> a function to be called on @data when the stream is finalized, -or %NULL +<parameter name="destroy_function"> +<parameter_description> a function to be called on @data when the stream is +finalized, or %NULL </parameter_description> </parameter> </parameters> @@ -19485,78 +19158,60 @@ or %NULL </return> </function> -<function name="g_file_info_get_display_name"> +<function name="g_drive_get_identifier"> <description> -Gets a display name for a file. +Gets the identifier of the given kind for @drive. </description> <parameters> -<parameter name="info"> -<parameter_description> a #GFileInfo. +<parameter name="drive"> +<parameter_description> a #GDrive </parameter_description> </parameter> -</parameters> -<return> a string containing the display name. -</return> -</function> - -<function name="g_inet_address_get_is_mc_org_local"> -<description> -Tests whether @address is an organization-local multicast address. - - -</description> -<parameters> -<parameter name="address"> -<parameter_description> a #GInetAddress +<parameter name="kind"> +<parameter_description> the kind of identifier to return </parameter_description> </parameter> </parameters> -<return> %TRUE if @address is an organization-local multicast address. - -Since: 2.22 +<return> a newly allocated string containing the +requested identfier, or %NULL if the #GDrive +doesn't have this kind of identifier. </return> </function> -<function name="g_socket_client_connect_to_host_async"> +<function name="g_file_monitor_directory"> <description> -This is the asynchronous version of g_socket_client_connect_to_host(). +Obtains a directory monitor for the given file. +This may fail if directory monitoring is not supported. -When the operation is finished @callback will be -called. You can then call g_socket_client_connect_to_host_finish() to get -the result of the operation. +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. -Since: 2.22 </description> <parameters> -<parameter name="client"> -<parameter_description> a #GTcpClient -</parameter_description> -</parameter> -<parameter name="host_and_port"> -<parameter_description> the name and optionally the port of the host to connect to +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="default_port"> -<parameter_description> the default port to connect to +<parameter name="flags"> +<parameter_description> a set of #GFileMonitorFlags. </parameter_description> </parameter> <parameter name="cancellable"> -<parameter_description> a #GCancellable, or %NULL -</parameter_description> -</parameter> -<parameter name="callback"> -<parameter_description> a #GAsyncReadyCallback +<parameter_description> optional #GCancellable object, %NULL to ignore. </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> user data for the callback +<parameter name="error"> +<parameter_description> a #GError, or %NULL. </parameter_description> </parameter> </parameters> -<return></return> +<return> a #GFileMonitor for the given @file, or %NULL on error. +Free the returned object with g_object_unref(). +</return> </function> <function name="g_volume_eject_finish"> @@ -19564,6 +19219,7 @@ Since: 2.22 Finishes ejecting a volume. If any errors occured during the operation, @error will be set to contain the errors and %FALSE will be returned. +Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead. </description> <parameters> @@ -19582,7 +19238,6 @@ Finishes ejecting a volume. If any errors occured during the operation, </parameters> <return> %TRUE, %FALSE if operation failed. -Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead. </return> </function> @@ -19640,31 +19295,63 @@ Checks if the unix mount points have changed since a given unix time. </return> </function> -<function name="g_socket_client_connect_finish"> +<function name="g_file_replace_contents_async"> <description> -Finishes an async connect operation. See g_socket_client_connect_async() +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 +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. + +If @make_backup is %TRUE, this function will attempt to +make a backup of @file. </description> <parameters> -<parameter name="client"> -<parameter_description> a #GSocketClient. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. +<parameter name="contents"> +<parameter_description> string of contents to replace the file with. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="length"> +<parameter_description> the length of @contents in bytes. +</parameter_description> +</parameter> +<parameter name="etag"> +<parameter_description> a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL +</parameter_description> +</parameter> +<parameter name="make_backup"> +<parameter_description> %TRUE if a backup should be created. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a set of #GFileCreateFlags. +</parameter_description> +</parameter> +<parameter name="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> a #GSocketConnection on success, %NULL on error. - -Since: 2.22 -</return> +<return></return> </function> <function name="g_file_query_file_type"> @@ -19675,6 +19362,7 @@ 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. +Since: 2.18 </description> <parameters> @@ -19694,7 +19382,6 @@ directory, or symlink. <return> The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file does not exist -Since: 2.18 </return> </function> @@ -19703,6 +19390,7 @@ Since: 2.18 Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. +Deprecated: 2.22: Use g_mount_unmount_with_operation_finish() instead. </description> <parameters> @@ -19722,7 +19410,6 @@ ignore. </parameters> <return> %TRUE if the mount was successfully unmounted. %FALSE otherwise. -Deprecated: 2.22: Use g_mount_unmount_with_operation_finish() instead. </return> </function> @@ -19742,6 +19429,28 @@ Gets the size of the buffer in the @stream. </return> </function> +<function name="g_file_info_get_attribute_int32"> +<description> +Gets a signed 32-bit integer contained within the attribute. If the +attribute does not contain a signed 32-bit integer, or is invalid, +0 will be returned. + + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GFileInfo. +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> a file attribute key. +</parameter_description> +</parameter> +</parameters> +<return> a signed 32-bit integer from the attribute. +</return> +</function> + <function name="g_drive_stop"> <description> Asynchronously stops a drive. @@ -19823,7 +19532,11 @@ not contain a #GObject, %NULL will be returned. <function name="g_memory_output_stream_get_data_size"> <description> -Returns: the number of bytes written to the stream +Returns the number of bytes from the start up +to including the last byte written in the stream +that has not been truncated away. + +Since: 2.18 </description> <parameters> @@ -19834,7 +19547,6 @@ Returns: the number of bytes written to the stream </parameters> <return> the number of bytes written to the stream -Since: 2.18 </return> </function> @@ -19854,35 +19566,21 @@ References a file attribute matcher. </return> </function> -<function name="GFilenameCompleter"> -<description> -Emitted when the file name completion information comes available. - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_app_info_get_id"> +<function name="g_inet_socket_address_get_port"> <description> -Gets the ID of an application. An id is a string that -identifies the application. The exact format of the id is -platform dependent. For instance, on Unix this is the -desktop file id from the xdg menu specification. - -Note that the returned ID may be %NULL, depending on how -the @appinfo has been constructed. +Gets @address's port. +Since: 2.22 </description> <parameters> -<parameter name="appinfo"> -<parameter_description> a #GAppInfo. +<parameter name="address"> +<parameter_description> a #GInetSocketAddress </parameter_description> </parameter> </parameters> -<return> a string containing the application's ID. +<return> the port for @address + </return> </function> @@ -19920,6 +19618,7 @@ If @parent is %NULL then this function returns %TRUE if @file has any parent at all. If @parent is non-%NULL then %TRUE is only returned if @file is a child of @parent. +Since: 2.24 </description> <parameters> @@ -19935,7 +19634,6 @@ if @file is a child of @parent. <return> %TRUE if @file is a child of @parent (or any parent in the case that @parent is %NULL). -Since: 2.24 </return> </function> @@ -19978,6 +19676,7 @@ the output stream is destroyed. <description> Try to get the remote address of a socket connection. +Since: 2.22 </description> <parameters> @@ -19993,7 +19692,6 @@ Try to get the remote address of a socket connection. <return> a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -20017,37 +19715,19 @@ Since: 2.22 <return></return> </function> -<function name="g_input_stream_close"> +<function name="g_data_output_stream_put_uint16"> <description> -Closes the stream, releasing resources related to it. - -Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. -Closing a stream multiple times will not return an error. - -Streams will be automatically closed when the last reference -is dropped, but you might want to call this function to make sure -resources are released as early as possible. - -Some streams might keep the backing store of the stream (e.g. a file descriptor) -open after the stream is closed. See the documentation for the individual -stream for details. - -On failure the first error that happened will be reported, but the close -operation will finish as much as possible. A stream that failed to -close will still return %G_IO_ERROR_CLOSED for all operations. Still, it -is important to check and report the error to the user. - -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. -Cancelling a close will still leave the stream closed, but some streams -can use a faster close that doesn't block to e.g. check errors. +Puts an unsigned 16-bit integer into the output stream. </description> <parameters> <parameter name="stream"> -<parameter_description> A #GInputStream. +<parameter_description> a #GDataOutputStream. +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> a #guint16. </parameter_description> </parameter> <parameter name="cancellable"> @@ -20055,49 +19735,51 @@ can use a faster close that doesn't block to e.g. check errors. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> a #GError, %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> %TRUE on success, %FALSE on failure +<return> %TRUE if @data was successfully added to the @stream. </return> </function> -<function name="g_initable_new_valist"> +<function name="g_simple_async_result_new_error"> <description> -Helper function for constructing #GInitiable object. This is -similar to g_object_new_valist() but also initializes the object -and returns %NULL, setting an error on failure. +Creates a new #GSimpleAsyncResult with a set error. </description> <parameters> -<parameter name="object_type"> -<parameter_description> a #GType supporting #GInitable. +<parameter name="source_object"> +<parameter_description> a #GObject, or %NULL. </parameter_description> </parameter> -<parameter name="first_property_name"> -<parameter_description> the name of the first property, followed by -the value, and other property value pairs, and ended by %NULL. +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback. </parameter_description> </parameter> -<parameter name="var_args"> -<parameter_description> The var args list generated from @first_property_name. +<parameter name="user_data"> +<parameter_description> user data passed to @callback. </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter name="domain"> +<parameter_description> a #GQuark. </parameter_description> </parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="code"> +<parameter_description> an error code. +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> a string with format characters. +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> a list of values to insert into @format. </parameter_description> </parameter> </parameters> -<return> a newly allocated #GObject, or %NULL on error - -Since: 2.22 +<return> a #GSimpleAsyncResult. </return> </function> @@ -20114,6 +19796,7 @@ If there are no outstanding connections then the operation will block or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the %G_IO_IN condition. +Since: 2.22 </description> <parameters> @@ -20133,7 +19816,6 @@ To be notified of an incoming connection, wait for the %G_IO_IN condition. <return> a new #GSocket, or %NULL on error. Free the returned object with g_object_unref(). -Since: 2.22 </return> </function> @@ -20178,34 +19860,33 @@ of the request. <return></return> </function> -<function name="g_socket_listener_accept_finish"> +<function name="g_file_unmount_mountable_finish"> <description> -Finishes an async accept operation. See g_socket_listener_accept_async() +Finishes an unmount operation, see g_file_unmount_mountable() for details. +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. </description> <parameters> -<parameter name="listener"> -<parameter_description> a #GSocketListener +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> <parameter name="result"> <parameter_description> a #GAsyncResult. </parameter_description> </parameter> -<parameter name="source_object"> -<parameter_description> Optional #GObject identifying this source -</parameter_description> -</parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter_description> a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return> a #GSocketConnection on success, %NULL on error. +<return> %TRUE if the operation finished successfully. %FALSE +otherwise. -Since: 2.22 </return> </function> @@ -20217,6 +19898,7 @@ contexts</link>. If this returns %FALSE, you cannot perform asynchronous operations on @file in a thread that has a thread-default context. +Since: 2.22 </description> <parameters> @@ -20227,7 +19909,6 @@ thread-default context. </parameters> <return> Whether or not @file supports thread-default contexts. -Since: 2.22 </return> </function> @@ -20237,6 +19918,7 @@ Gets the size of @address's native <type>struct sockaddr</type>. You can use this to allocate memory to pass to g_socket_address_to_native(). +Since: 2.22 </description> <parameters> @@ -20248,7 +19930,6 @@ g_socket_address_to_native(). <return> the size of the native <type>struct sockaddr</type> that @address represents -Since: 2.22 </return> </function> @@ -20317,6 +19998,47 @@ Since: 2.22 <return></return> </function> +<function name="g_io_stream_close_async"> +<description> +Requests an asynchronous close of the stream, releasing resources +related to it. When the operation is finished @callback will be +called. You can then call g_io_stream_close_finish() to get +the result of the operation. + +For behaviour details see g_io_stream_close(). + +The asynchronous methods have a default fallback that uses threads +to implement asynchronicity, so they are optional for inheriting +classes. However, if you override one you must override all. + +Since: 2.22 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a #GIOStream +</parameter_description> +</parameter> +<parameter name="io_priority"> +<parameter_description> the io priority of the request +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback 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> +<parameter name="cancellable"> +<parameter_description> optional cancellable object +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_io_stream_close"> <description> Closes the stream, releasing resources related to it. This will also @@ -20353,6 +20075,7 @@ can use a faster close that doesn't block to e.g. check errors. The default implementation of this method just calls close on the individual input/output streams. +Since: 2.22 </description> <parameters> @@ -20371,47 +20094,21 @@ individual input/output streams. </parameters> <return> %TRUE on success, %FALSE on failure -Since: 2.22 </return> </function> -<function name="g_socket_listener_accept"> +<function name="g_unix_fd_message_new"> <description> -Blocks waiting for a client to connect to any of the sockets added -to the listener. Returns a #GSocketConnection for the socket that was -accepted. - -If @source_object is not %NULL it will be filled out with the source -object specified when the corresponding socket or address was added -to the listener. - -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. +Creates a new #GUnixFDMessage containing an empty file descriptor +list. +Since: 2.22 </description> <parameters> -<parameter name="listener"> -<parameter_description> a #GSocketListener -</parameter_description> -</parameter> -<parameter name="source_object"> -<parameter_description> location where #GObject pointer will be stored, or %NULL -</parameter_description> -</parameter> -<parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> #GError for error reporting, or %NULL to ignore. -</parameter_description> -</parameter> </parameters> -<return> a #GSocketConnection on success, %NULL on error. +<return> a new #GUnixFDMessage -Since: 2.22 </return> </function> @@ -20479,28 +20176,22 @@ in @result. <return></return> </function> -<function name="g_input_stream_read_finish"> +<function name="g_file_get_uri"> <description> -Finishes an asynchronous stream read operation. +Gets the URI for the @file. + +This call does no blocking i/o. </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GInputStream. -</parameter_description> -</parameter> -<parameter name="result"> -<parameter_description> a #GAsyncResult. -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter name="file"> +<parameter_description> input #GFile. </parameter_description> </parameter> </parameters> -<return> number of bytes read in, or -1 on error. +<return> a string containing the #GFile's URI. +The returned string should be freed with g_free() when no longer needed. </return> </function> @@ -20541,41 +20232,51 @@ Since: 2.20 <return></return> </function> -<function name="g_io_stream_close_async"> +<function name="g_unix_mount_guess_can_eject"> <description> -Requests an asynchronous close of the stream, releasing resources -related to it. When the operation is finished @callback will be -called. You can then call g_io_stream_close_finish() to get -the result of the operation. +Guesses whether a Unix mount can be ejected. -For behaviour details see g_io_stream_close(). -The asynchronous methods have a default fallback that uses threads -to implement asynchronicity, so they are optional for inheriting -classes. However, if you override one you must override all. +</description> +<parameters> +<parameter name="mount_entry"> +<parameter_description> a #GUnixMountEntry +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @mount_entry is deemed to be ejectable. +</return> +</function> + +<function name="g_resolver_lookup_by_name_async"> +<description> +Begins asynchronously resolving @hostname to determine its +associated IP address(es), and eventually calls @callback, which +must call g_resolver_lookup_by_name_finish() to get the result. +See g_resolver_lookup_by_name() for more details. Since: 2.22 </description> <parameters> -<parameter name="stream"> -<parameter_description> a #GIOStream +<parameter name="resolver"> +<parameter_description> a #GResolver </parameter_description> </parameter> -<parameter name="io_priority"> -<parameter_description> the io priority of the request +<parameter name="hostname"> +<parameter_description> the hostname to look up the address of </parameter_description> </parameter> -<parameter name="callback"> -<parameter_description> callback to call when the request is satisfied +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL </parameter_description> </parameter> -<parameter name="user_data"> -<parameter_description> the data to pass to callback function +<parameter name="callback"> +<parameter_description> callback to call after resolution completes </parameter_description> </parameter> -<parameter name="cancellable"> -<parameter_description> optional cancellable object +<parameter name="user_data"> +<parameter_description> data for @callback </parameter_description> </parameter> </parameters> |