{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ func.name }}{% endblock %} {% block meta_other %} {% endblock %} {% block sidebar %} {% if func.is_macro %}
Function Macros
{% for f in namespace.function_macros %} {{ f.name }} {% endfor %}
{% else %}
Functions
{% for f in namespace.functions %} {{ f.name }} {% endfor %}
{% endif %} {% endblock %} {% block content %}

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 %}

{{ func.description }}
{% if func.stability %} {% endif %} {% if func.available_since %} {% endif %} {% if func.deprecated_since %} {% endif %} {% if not func.introspectable %} {% endif %} {% if func.shadows %} {% endif %} {% if func.shadowed_by %} {% 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
{% if func.attributes %}
{% for (key, value) in func.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if func.arguments|length != 0 %}

Parameters

{% for arg in func.arguments %} {% if arg.direction != "in" %}{% endif %} {% if arg.direction == "in" and arg.nullable %}{% endif %} {% if arg.direction in ["inout", "out"] and arg.nullable %}{% endif %} {% if arg.optional %}{% endif %} {% if arg.is_array and arg.zero_terminated %}{% endif %} {% if arg.is_array and arg.fixed_size > 0 %}{% endif %} {% if arg.is_array and arg.len_arg %}{% endif %} {% if arg.is_pointer %}{% endif %} {% if arg.string_note %}{% endif %} {% endfor %} {% if func.throws %} {% endif %}
{{ arg.name }} {%- 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 }}
 {{ arg.direction_note }}
 The argument can be NULL.
 The argument can be set to NULL.
 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 }}
error GError **
  The return location for a GError*, or NULL.
{% endif %} {% if func.return_value %}

Return value

{% if func.return_value.is_array and func.return_value.zero_terminated %}{% endif %} {% if func.return_value.is_array and func.return_value.fixed_size > 0 %}{% endif %} {% if func.return_value.is_array and func.return_value.len_arg %}{% endif %} {% if func.return_value.is_pointer %}{% endif %} {% if func.return_value.is_pointer and func.return_value.nullable %}{% endif %} {% if func.return_value.string_note %}{% endif %}
Returns: {%- 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 }}
{% endif %}
{% endblock %}