/ gwscandiskinfo.h / Functions / Description

Functions



scan_disk_info_new

Creates a new scan disk information
struct scan_disk_info * scan_disk_info_new ( void);
This function creates a new scan disk information. It's an allocation function.
VFSStats and Categories are collaboratived and all other data agregated.

Result: a pointer to the scan disk information structure. Returns NULL when an error occured..


scan_disk_info_set_vfs

Sets the VFSStats to scan
gint scan_disk_info_set_vfs ( struct scan_disk_info *p, struct vfs_stats *vfs);
This function sets the VFSStats to scan.

Parameters
p the scan disk information to set VFSStats
vfs the VFSStats

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


scan_disk_info_set_disk_name

Sets the disk name for catalog
gint scan_disk_info_set_disk_name ( struct scan_disk_info *p, gchar *name);
This function sets the disk name for catalog.

Parameters
p the scan disk information to set disk name
name the disk name

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


scan_disk_info_set_disk_num_archive

Sets the disk number archive for catalog
gint scan_disk_info_set_disk_num_archive ( struct scan_disk_info *p, gint num);
This function sets the disk number archive for catalog.

Parameters
p the scan disk information to set number archive
num the disk number archive

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


scan_disk_info_set_disk_category

Sets the category disk for catalog
gint scan_disk_info_set_disk_category ( struct scan_disk_info *p, struct category *category);
This function sets the category disk for catalog.

Parameters
p the scan disk information to set category
category the category

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


scan_disk_info_set_explore_tree_structure

Sets if the scan disk had to explore tree structure
gint scan_disk_info_set_explore_tree_structure ( struct scan_disk_info *p, gboolean tree_structure);
This function sets if the scan disk had to explore tree structure.

Parameters
p the scan disk information to set explore tree structure status
tree_structure TRUE to explore files archive or FALSE to no explore them

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


scan_disk_info_set_explore_archive

Sets if the scan disk had to explore archive files
gint scan_disk_info_set_explore_archive ( struct scan_disk_info *p, gboolean explore_archive);
This function sets if the scan disk had to explore archive files.

Parameters
p the scan disk information to set explore archive files status
explore_archive TRUE to explore files archive or FALSE to no explore them

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


scan_disk_info_set_make_description

Sets if the scan disk had to make file description
gint scan_disk_info_set_make_description ( struct scan_disk_info *p, gboolean make_description);
This function sets if the scan disk had to make file description.

Parameters
p the scan disk information to set make file description status
make_description TRUE to make description or FALSE to not make description

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


scan_disk_info_set_category_recursive

Sets if the scan disk had to set recursively category
gint scan_disk_info_set_category_recursive ( struct scan_disk_info *p, gboolean category_recursive);
This function sets if the scan disk had to set recursively category.

Parameters
p the scan disk information to set recursively category status
category_recursive TRUE to set category recursively or FALSE to not set them

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


scan_disk_info_set_stop

Sets if the scan disk must stop
gint scan_disk_info_set_stop ( struct scan_disk_info *p, gboolean stop);
This function sets if the scan disk had to stop.

Parameters
p the scan disk information to set stop status
stop TRUE to stop scan disk or FALSE to continue

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


scan_disk_info_set_error_msg

Sets the error message
gint scan_disk_info_set_error_msg ( struct scan_disk_info *p, gchar *error_msg);
This function sets the error message. The message indicate why the scan disk failed.

Parameters
p the scan disk information to set error message
error_ms the error message

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


scan_disk_info_set_statment_controler

Sets the statment controler
gint scan_disk_info_set_statment_controler ( struct scan_disk_info *p, gpointer statment_controler);
This function sets the statment controler. This controler is the first parameter of func_stament_t function.

Parameters
p the scan disk information to set statment controler
statment_controler the statment controler

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


scan_disk_info_set_scan_disk_get_file_description

Sets the function to get file description
gint scan_disk_info_set_scan_disk_get_file_description ( struct scan_disk_info *p, func_descr_t f);
This function sets the function to get file description. This is active only if "make description" is activated.

Parameters
p the scan disk information to set make description function
f the function

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


scan_disk_info_set_scan_disk_set_current_statment

Sets the function to set current process statment
gint scan_disk_info_set_scan_disk_set_current_statment ( struct scan_disk_info *p, func_statment_t f);
This function sets the function to set current process statment.

Parameters
p the scan disk information to set current process statment status
f the function

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


scan_disk_info_get_vfs

Gets the VFSStats to scan
struct vfs_stats * scan_disk_info_get_vfs ( struct scan_disk_info *p);
This function gets the VFSStats to scan.

Parameters
p the scan disk information to get VFSStats

Result: the VFSStats. Returns NULL when an error occured..


scan_disk_info_get_disk_name

Gets the disk name for catalog
gchar * scan_disk_info_get_disk_name ( struct scan_disk_info *p);
This function gets the disk name for catalog.

Parameters
p the scan disk information to get disk name

Result: the disk name Returns NULL when an error occured..


scan_disk_info_get_disk_num_archive

Gets the disk number archive for catalog
gint scan_disk_info_get_disk_num_archive ( struct scan_disk_info *p);
This function gets the disk number archive for catalog.

Parameters
p the scan disk information to get number archive

Result: the disk number archive Returns -1 when an error occured..


scan_disk_info_get_disk_category

Gets the disk category for catalog
struct category * scan_disk_info_get_disk_category ( struct scan_disk_info *p);
This function gets the disk category for catalog.

Parameters
p the scan disk information to get

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


scan_disk_info_get_explore_tree_structure

Gets if the scan disk had to explore tree structure
gboolean scan_disk_info_get_explore_tree_structure ( struct scan_disk_info *p);
This function gets if the scan disk had to explore tree structure.

Parameters
p the scan disk information to get explore tree structure status

Result: TRUE if must explore tree structure or FALSE if not explore them.


scan_disk_info_get_explore_archive

Gets if the scan disk had to explore archive files
gboolean scan_disk_info_get_explore_archive ( struct scan_disk_info *p);
This function gets if the scan disk had to explore archives files.

Parameters
p the scan disk information to get explore archive status

Result: TRUE if must explore files archive or FALSE if not explore them.


scan_disk_info_get_make_description

Gets if the scan disk had to make file description
gboolean scan_disk_info_get_make_description ( struct scan_disk_info *p);
This function gets if the scan disk had to make file description. To make file description the "get file description" must be set.

Parameters
p the scan disk information to get make description status

Result: TRUE if must to make description or FALSE to not make description.


scan_disk_info_get_category_recursive

Gets if the scan disk had to set category recursively
gboolean scan_disk_info_get_category_recursive ( struct scan_disk_info *p);
This function gets of the scan disk had to set category recursively to the catalog. If the category is applicated recursively all sub item of catalog will have this category (folder, subfolder, files).

Parameters
p the scan disk information to get category recursively status

Result: TRUE if must to set category recursively or FALSE to not set them.


scan_disk_info_get_stop

Gets if the scan disk had to stop
gboolean scan_disk_info_get_stop ( struct scan_disk_info *p);
This function gets if the scan disk had to stop process. This property is usefull to cancel a scan disk (with an external process). Use this methode to check when scan disk must stop.

Parameters
p the scan disk information to get stop status

Result: TRUE to stop scan disk or FALSE to continue.


scan_disk_info_get_error_msg

Gets the error message
gchar * scan_disk_info_get_error_msg ( struct scan_disk_info *p);
This function gets the error message. The error message may be put when a error occured during scan disk or when the process is stoped. The error message may be use in order to send a report or anything.

Parameters
p the scan disk information to get error message

Result: the error message or NULL if there are no message. Return NULL when an error occured..


scan_disk_info_get_statment_controler

Gets the statment controler
gpointer scan_disk_info_get_statment_controler ( struct scan_disk_info *p);
This function gets the statment controler. This controler must use with func_statment_t function.

Parameters
p the scan disk information to get statment controler

Result: the statment controler or NULL if there are no statment controler. Return NULL when an error occured..


scan_disk_info_get_scan_disk_get_file_description

Gets the function to get file description
func_descr_t scan_disk_info_get_scan_disk_get_file_description ( struct scan_disk_info *p);
This function get the function to get file description. This function must be use only if the "make description" status is set.

Parameters
p the scan disk information to get function

Result: the function or NULL if there are no function. Returns NULL when an error occured..


scan_disk_info_get_scan_disk_set_current_statment

Gets the function to set current process statment
func_statment_t scan_disk_info_get_scan_disk_set_current_statment ( struct scan_disk_info *p);
This function gets the function to set current process statment

Parameters
p the scan disk information to get function

Result: the function or NULL if there are no function. Returns NULL when an error occured..


scan_disk_info_free

Frees data structure
gint scan_disk_info_free ( struct scan_disk_info *p);
This function frees the scan disk data structure. Doesn't free VFSStats, Category, Statment Controler because they're collaboratives.

Parameters
p the scan disk information to free

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