Class method
{{ namespace.name }}{{ class.class_name }}{{ class_method.name }}
Declaration {% if CONFIG.source_location_url and class_method.source_location %} [src] {% endif %}
{{ class_method.c_decl }}
Description {% if CONFIG.source_location_url and class_method.docs_location %} [src] {% endif %}
{{ class_method.description }}
| Stability: | {{ class_method.stability }} |
| Available since: | {{ class_method.available_since }} |
| Deprecated since: | {{ class_method.deprecated_since.version }} |
| {{ class_method.deprecated_since.message }} | |
| {{ 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 class_method.return_value.is_array -%}An array of {%- endif -%}
{%- if class_method.return_value.is_list -%}A list of {%- endif -%}
{%- if class_method.return_value.is_list_model -%}A list model of {%- endif -%}
{%- if class_method.return_value.link -%}
{{ class_method.return_value.link|safe }}
{%- else -%}
{{ class_method.return_value.type_cname }}
{%- endif -%}
|
| {{ class_method.return_value.description|safe }} | |
The array is NULL-terminated. | |
| The array has {{ class_method.return_value.fixed_size }} elements. | |
The length of the array is in the {{ class_method.return_value.len_arg }} argument. | |
| {{ class_method.return_value.transfer_note }} | |
The return value can be NULL. | |
| {{ class_method.return_value.string_note }} |