Method
{{ namespace.name }}{{ class.name }}{{ method.name }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since.version }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Declaration {% if CONFIG.source_location_url and method.source_location %} [src] {% endif %}
{{ method.c_decl|safe }}
Description {% if CONFIG.source_location_url and method.docs_location %} [src] {% endif %}
Stability: {{ method.stability }}
{%- endif %} {% if method.available_since -%}Available since: {{ method.available_since }}
{%- endif %} {% if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since.version }}
{%- if method.deprecated_since.message -%} {{ method.deprecated_since.message }} {%- else -%}Do not use in newly written code.
{%- endif -%}This method completes asynchronously. Use {{method.finish_func_symbol}}() inside the GAsyncReadyCallback to obtain the result of the operation.
This method is not directly available to language bindings.
{%- endif %} {% if method.shadows -%}This method is renamed to {{method.shadows_symbol}}() in language bindings.
The implementation of this method is provided by {{method.shadowed_by_symbol}}() in language bindings.
| {{ key|escape }} | {{ value|escape }} |
Parameters
-
{% for arg in method.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.nullable %}{{ arg.direction_note }} {% endif %} {% if arg.direction in ["inout", "out"] and arg.nullable %}The argument can be NULL. {% endif %} {% if arg.optional %}The argument can be set to NULLby the method. {% 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 method.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 aNULLGError*.The argument will be left initialized to NULLby the method 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 method.return_value.is_array -%}An array of {%- endif -%}
{%- if method.return_value.is_list -%}A list of {%- endif -%}
{%- if method.return_value.is_list_model -%}A list model of {%- endif -%}
{%- if method.return_value.link -%}
{{ method.return_value.link|safe }}
{%- else -%}
{{ method.return_value.type_cname }}
{%- endif -%}
The array is NULL-terminated. |
| The array has {{ method.return_value.fixed_size }} elements. |
The length of the array is in the {{ method.return_value.len_arg }} argument. |
| {{ method.return_value.transfer_note }} |
The return value can be NULL. |
| {{ method.return_value.string_note }} |