Method

CamelStoreDBrename_folder

unstable since: 3.58

Declaration [src]

gboolean
camel_store_db_rename_folder (
  CamelStoreDB* self,
  const gchar* old_folder_name,
  const gchar* new_folder_name,
  GError** error
)

Description [src]

Renames folder old_folder_name to new_folder_name. Returns failure and sets G_IO_ERROR_NOT_FOUND error when the old_folder_name does not exist, and G_IO_ERROR_EXISTS, when the new_folder_name already exists.

Available since: 3.58

Parameters

old_folder_name

Type: const gchar*

An existing folder name.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
new_folder_name

Type: const gchar*

A folder name to rename to.

The data is owned by the caller of the method.
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 method 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: gboolean

Whether succeeded.