Function

EDataServerCollatornew

since: 3.12

Declaration [src]

ECollator*
e_collator_new (
  const gchar* locale,
  GError** error
)

Description [src]

Creates a new ECollator for the given locale, the returned collator should be freed with e_collator_unref().

Available since: 3.12

Parameters

locale

Type: const gchar*

The locale under which to sort.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
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 a NULL GError*.
The argument will be left initialized to NULL by 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.

Return value

Type: ECollator

A newly created ECollator.

The caller of the function takes ownership of the data, and is responsible for freeing it.