aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2000-06-16 09:27:55 +0800
committerDan Winship <danw@src.gnome.org>2000-06-16 09:27:55 +0800
commit4ad1d8f78370bd4604dabefc35f39c42c9991038 (patch)
tree7753c69544dc81e1394315edfe4b4d74ddc26ae8
parentb52a9eaa1ca1f7698516ce0635263e7e2177669d (diff)
downloadgsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar.gz
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar.bz2
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar.lz
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar.xz
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.tar.zst
gsoc2013-evolution-4ad1d8f78370bd4604dabefc35f39c42c9991038.zip
document camel_folder_search_by_expression
svn path=/trunk/; revision=3587
-rw-r--r--camel/camel-folder.c17
1 files changed, 14 insertions, 3 deletions
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 6fda77d5d1..a5ccc24070 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -842,9 +842,20 @@ search_by_expression (CamelFolder *folder, const char *expression,
return NULL;
}
-GList *camel_folder_search_by_expression (CamelFolder *folder,
- const char *expression,
- CamelException *ex)
+/**
+ * camel_folder_search_by_expression:
+ * @folder: Folder object
+ * @expression: a search expression
+ * @ex: a CamelException
+ *
+ * Searches the folder for messages matching the given search expression.
+ *
+ * Return value: a list of uids of matching messages. The caller must
+ * free the list and each of the elements when it is done.
+ **/
+GList *
+camel_folder_search_by_expression (CamelFolder *folder, const char *expression,
+ CamelException *ex)
{
g_return_val_if_fail (CAMEL_IS_FOLDER (folder), NULL);
g_return_val_if_fail (folder->has_search_capability, NULL);