/ gwsearchiteminfo.h / Functions / Description

Functions



search_item_info_new

Creates a new search item information.
struct search_item_info * search_item_info_new ( void);
This function creates a new search item information. It's an allocation function.

Result: a pointer to the search item information structure.
Returns NULL when an error occured.
.


search_item_info_set_type

Sets the search item type.
gint search_item_info_set_type ( struct search_item_info *p, gint type);
This function sets the type of the search item

Parameters
p the search item information to set the name
type the type

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_name

Sets the search item name.
gint search_item_info_set_name ( struct search_item_info *p, gchar *name);
This function sets the name of the search item

Parameters
p the search item information to set the name
name the name

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_disk

Sets the search item disk.
gint search_item_info_set_disk ( struct search_item_info *p, gchar *disk);
This function sets the disk of the search item

Parameters
p the search item information to set the disk
disk the disk

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_path

Sets the search item path.
gint search_item_info_set_path ( struct search_item_info *p, gchar *path);
This function sets the path of the search item

Parameters
p the search item information to set the path
path the path

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_size

Sets the search item size.
gint search_item_info_set_size ( struct search_item_info *p, guint64 size);
This function sets the search item information size.


Parameters
p the search item information to set size
size the size

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_date

Sets the search item date.
gint search_item_info_set_date ( struct search_item_info *p, gulong date);
This function sets the search item information date.


Parameters
p the search item information to set date
cdate the creation date

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_category

Sets the search item category.
gint search_item_info_set_category ( struct search_item_info *p, struct category *category);
This function sets the search item information category. The category is struct category


Parameters
p the information to set category
category the category

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_set_description

Sets the search item description.
gint search_item_info_set_description ( struct search_item_info *p, gchar *description);
This function sets the search item information description.


Parameters
p the search item information to set description
description the description

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.


search_item_info_get_type

Gets the search item type.
gint search_item_info_get_type ( struct search_item_info *p);
This function gets the search item information type.


Parameters
p the search item information to get type

Result: The name.
Returns NULL when an error occured.
.


search_item_info_get_name

Gets the search item name.
gchar * search_item_info_get_name ( struct search_item_info *p);
This function gets the search item information name.


Parameters
p the search item information to get name

Result: The name.
Returns NULL when an error occured.
.


search_item_info_get_disk

Gets the search item disk.
gchar * search_item_info_get_disk ( struct search_item_info *p);
This function gets the search item information disk.


Parameters
p the search item information to get disk

Result: The disk.
Returns NULL when an error occured.
.


search_item_info_get_path

Gets the search item path.
gchar * search_item_info_get_path ( struct search_item_info *p);
This function gets the search item information path.


Parameters
p the search item information to get path

Result: The path.
Returns NULL when an error occured.
.


search_item_info_get_size

Gets the search item size.
guint64 search_item_info_get_size ( struct search_item_info *p);
This functions gets the search item information size.


Parameters
p the search item information to get size

Result: The size.
Returns -1 when an error occured.
.


search_item_info_get_date

Gets the search item date.
gulong search_item_info_get_date ( struct search_item_info *p);
This function gets the search item information date.


Parameters
p the search item information to get date

Result: The date.
Returns 0 when an error occured.
.


search_item_info_get_category

Gets the search item category.
struct category * search_item_info_get_category ( struct search_item_info *p);
This function gets the search item information category. The category is the category datas structure.


Parameters
p the search item information to get category

Result: The category.
Returns NULL when an error occured.
.


search_item_info_get_category_name

Gets the search item category name.
gchar * search_item_info_get_category_name ( struct search_item_info *p);
This function gets the search item category name.


Parameters
p the search item information to get category name

Result: The category name.
Returns "" when there are not category.
Returns NULL when an error occured.
.


search_item_info_get_category_index

Gets the search item category index.
gint search_item_info_get_category_index ( struct search_item_info *p);
This function gets the search item information category index.


Parameters
p the search item information to get category index

Result: The category index.
Returns -1 when an error occured.
.


search_item_info_get_description

Gets the search item description.
gchar * search_item_info_get_description ( struct search_item_info *p);
This function gets the search item information description.


Parameters
p the search item information to get description

Result: The description.
Returns NULL when an error occured.
.


search_item_info_get_date_to_gchar

Gets the formated search item date.
gchar * search_item_info_get_date_to_gchar ( struct search_item_info *p);
This function gets the formated search item information date.


Parameters
p the search item information to get formated date

Result: The formated date. Must be freed with g_free().
Returns NULL when an error occured.
.


search_item_info_free

Frees datas structure.
gint search_item_info_free ( struct search_item_info *p);
This function frees the search item information datas structure.
Doesn't free Category because it's collaborative.


Parameters
p the search item information to free

Result: an error code.
Returns 0 when it's done.
Returns -1 when an error occured.
.