Method
{{ namespace.name }}{{ class.name }}{{ method.name }}
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 %}
{{ method.description|safe }}
| Stability: | {{ method.stability }} |
| Available since: | {{ method.available_since }} |
| Deprecated since: | {{ method.deprecated_since.version }} |
| {{ method.deprecated_since.message|safe }} | |
| This method is not directly available to language bindings. | |
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
{{ 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 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 -%}
|
| {{ method.return_value.description|safe }} | |
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 }} |