Function
{{ namespace.name }}{{ class.name }}{{ type_func.name }}
{%- if CONFIG.is_unstable(type_func.available_since) -%} unstable {%- endif %} {%- if type_func.deprecated_since -%} deprecated: {{ type_func.deprecated_since.version }} {%- endif -%} {%- if type_func.available_since -%} since: {{ type_func.available_since }} {%- endif -%}
Declaration {% if CONFIG.source_location_url and type_func.source_location %} [src] {% endif %}
{{ type_func.c_decl }}
Description {% if CONFIG.source_location_url and type_func.docs_location %} [src] {% endif %}
Stability: {{ type_func.stability }}
{%- endif %} {% if type_func.available_since -%}Available since: {{ type_func.available_since }}
{%- endif %} {% if type_func.deprecated_since -%}Deprecated since: {{ type_func.deprecated_since.version }}
{%- if type_func.deprecated_since.message -%} {{ type_func.deprecated_since.message }} {%- else -%}Do not use in newly written code.
{%- endif -%}This function completes asynchronously. Use {{type_func.finish_func_symbol}}()
inside the GAsyncReadyCallback
to obtain the result of the operation.
This function is not directly available to language bindings.
{%- endif %} {% if type_func.shadows -%}This function is renamed to {{type_func.shadows_symbol}}()
in language bindings.
The implementation of this function is provided by {{type_func.shadowed_by_symbol}}()
in language bindings.
{{ key|escape }} | {{ value|escape }} |
Parameters
-
{% for arg in type_func.arguments %}
{{ arg.name }}
-
Type: {%- if arg.is_array -%}An array of {%- endif -%} {%- if arg.is_list -%}A list of {%- endif -%} {%- if arg.link -%} {{ arg.link|safe }} {%- else -%}
{{ arg.description|safe }}{{ arg.type_cname }}
{%- endif -%}{% if arg.direction != "in" %}
{% endif %} {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}{{ arg.direction_note }} {% endif %} {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}The argument can be NULL
. {% endif %} {% if arg.optional %}The argument can be set to NULL
by the function. {% endif %} {% if arg.is_array and arg.zero_terminated %}The argument can be NULL
. {% endif %} {% if arg.is_array and arg.fixed_size > 0 %}The array must be NULL
-terminated. {% endif %} {% if arg.is_array and arg.len_arg %}The array must have {{ arg.fixed_size }} elements. {% endif %} {% if arg.is_pointer %}The length of the array is specified in the {{ arg.len_arg }}
argument. {% endif %} {% if arg.string_note %}{{ arg.transfer_note }} {% endif %}{{ arg.string_note }}
{% endfor %}
{% if type_func.throws %}
error
-
Type:
GError **
The return location for a recoverable error.
The argument can be NULL
.If the return location is not NULL
, then you must initialize it to aNULL
GError*
.The argument will be left initialized to NULL
by the function if there are no errors.In case of error, the argument will be set to a newly allocated GError
; the caller will take ownership of the data, and be responsible for freeing it.
{% endif %}
Return value
Type:
{%- if type_func.return_value.is_array -%}An array of {%- endif -%}
{%- if type_func.return_value.is_list -%}A list of {%- endif -%}
{%- if type_func.return_value.is_list_model -%}A list model of {%- endif -%}
{%- if type_func.return_value.link -%}
{{ type_func.return_value.link|safe }}
{%- else -%}
{{ type_func.return_value.type_cname }}
{%- endif -%}
The array is NULL -terminated. |
The array has {{ type_func.return_value.fixed_size }} elements. |
The length of the array is in the {{ type_func.return_value.len_arg }} argument. |
{{ type_func.return_value.transfer_note }} |
The return value can be NULL . |
{{ type_func.return_value.string_note }} |