Function {% if func.is_macro %}Macro{% endif %}
{{ namespace.name }}{{ func.name }}
Declaration {% if CONFIG.source_location_url and func.source_location %} [src] {% endif %}
{{ func.c_decl }}
Description {% if CONFIG.source_location_url and func.docs_location %} [src] {% endif %}
Stability: | {{ func.stability }} |
Available since: | {{ func.available_since }} |
Deprecated since: | {{ func.deprecated_since.version }} |
{{ func.deprecated_since.message }} | |
This function is not directly available to language bindings | |
This function is renamed to {{func.shadows_symbol}}() in language bindings | |
The implementation of this function is provided by {{func.shadowed_by_symbol}}() in language bindings |
{{ key|escape }} | {{ value|escape }} |
Parameters
-
{% for arg in 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.type_cname }}
{%- endif -%}{{ arg.description|safe }}
{% 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 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 func.throws %}
error
-
Type:
GError **
The return location for an error.
The argument can be NULL
.The argument will be set to NULL
by the function if there are no errors.In case of error, the argument will be set and the caller will take ownership of the data, and be responsible for freeing it.
{% endif %}
Return value
Type:
{%- if func.return_value.is_array -%}An array of {%- endif -%}
{%- if func.return_value.is_list -%}A list of {%- endif -%}
{%- if func.return_value.is_list_model -%}A list model of {%- endif -%}
{%- if func.return_value.link -%}
{{ func.return_value.link|safe }}
{%- else -%}
{{ func.return_value.type_cname }}
{%- endif -%}
{{ func.return_value.description|safe }}
The array is NULL -terminated. |
The array has {{ func.return_value.fixed_size }} elements. |
The length of the array is in the {{ func.return_value.len_arg }} argument. |
{{ func.return_value.transfer_note }} |
The return value can be NULL . |
{{ func.return_value.string_note }} |