Virtual Method

CamelStorecreate_folder_sync

since: 3.0

Declaration [src]

CamelFolderInfo*
create_folder_sync (
  CamelStore* store,
  const gchar* parent_name,
  const gchar* folder_name,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Creates a new folder as a child of an existing folder. parent_name can be NULL to create a new top-level folder. The returned CamelFolderInfo struct should be freed with camel_folder_info_free().

Available since: 3.0

Parameters

parent_name

Type: const gchar*

Name of the new folder’s parent, or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
folder_name

Type: const gchar*

Name of the folder to create.

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

Type: GCancellable

Optional GCancellable object, or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
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 virtual 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: CamelFolderInfo

Info about the created folder, or NULL on error.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.
The return value can be NULL.