Function

GLibutf8_collate_key_for_filename

Declaration [src]

gchar*
g_utf8_collate_key_for_filename (
  const gchar* str,
  gssize len
)

Description [src]

Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp().

In order to sort filenames correctly, this function treats the dot ‘.’ as a special case. Most dictionary orderings seem to consider it insignificant, thus producing the ordering “event.c” “eventgenerator.c” “event.h” instead of “event.c” “event.h” “eventgenerator.c”. Also, we would like to treat numbers intelligently so that “file1” “file10” “file5” is sorted as “file1” “file5” “file10”.

Note that this function depends on the [current locale][setlocale].

Available since:2.8

Parameters

str const gchar*
 

A UTF-8 encoded string.

 The data is owned by the caller of the function.
 The string is a NUL terminated UTF-8 string.
len gssize
 

Length of str, in bytes, or -1 if str is nul-terminated.

Return value

Returns: gchar*
 

A newly allocated string. This string should be freed with g_free() when you are done with it.

 The caller of the function takes ownership of the data, and is responsible for freeing it.
 The string is a NUL terminated UTF-8 string.