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 }}
| 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
{{ 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. |
Return value
| 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 }} |