Function {% if func.is_macro %}Macro{% endif %}
{{ namespace.name }}{{ func.name }}
{%- if CONFIG.is_unstable(func.available_since) -%} unstable {%- endif %} {%- if func.deprecated_since -%} deprecated: {{ func.deprecated_since.version }} {%- endif -%} {%- if func.available_since -%} since: {{ func.available_since }} {%- endif -%}
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 }}
{%- endif %} {% if func.available_since -%}Available since: {{ func.available_since }}
{%- endif %} {% if func.deprecated_since -%}Deprecated since: {{ func.deprecated_since.version }}
{{ func.deprecated_since.message }} {%- else -%}Deprecated since: {{ func.deprecated_since.version }}. Do not use in newly written code
{%- endif -%}This function is not directly available to language bindings.
{%- endif %} {% if func.shadows -%}This method is renamed to {{func.shadows_symbol}}() in language bindings
The implementation of this method 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" %} {{ arg.direction_note }} The argument can be NULL.The argument can be set to NULLby the function.The argument can be NULL.The array must be NULL-terminated.The array must have {{ arg.fixed_size }} elements. The length of the array is specified in the {{ arg.len_arg }}argument.{{ arg.transfer_note }} {{ arg.string_note }} {% endfor %}
          {% if 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 aNULLGError*.The argument will left initialized to NULLby 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 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 }} |