Method
CamelStoreget_folder_sync
since: 3.0
Declaration [src]
CamelFolder*
camel_store_get_folder_sync (
CamelStore* store,
const gchar* folder_name,
CamelStoreGetFolderFlags flags,
GCancellable* cancellable,
GError** error
)
Parameters
folder_name-
Type:
const gchar*Name of the folder to get.
The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string. flags-
Type:
CamelStoreGetFolderFlagsFolder flags (create, save body index, etc).
cancellable-
Type:
GCancellableOptional
GCancellableobject, orNULL.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 aNULLGError*.The argument will be left initialized to NULLby 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: CamelFolder
The requested CamelFolder object, 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. |