Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

_AlpBundle Struct Reference

#include <include/hiker/bundlemgr.h>


Detailed Description

Data type used to refer to a particular bundle The AlpBundle type is a short integral type used to index available bundles.

An AlpBundle value will be good until (reset?). (If a bundle is deleted, the AlpBundle value will not be immediately reused). Any routine called with an invalid AlpBundle value will fail. Using an invalid AlpBundle value will not cause any alp_bundle routine to crash.

Do not attempt to manipulate AlpBundle values numerically: always use values returned from alp_bundle_by_name() or alp_bundle_search().

An AlpBundle may be "NULL", meaning that it is a not a valid bundle index. This condition can be tested with alp_bundle_is_NULL().

Note:
This type is a structure primarily so other numeric values aren't accidentally used as AlpBundle indexes. If you want to step over each available bundle, use alp_bundle_search() with a set of NULL parameters to retrieve all valid bundle indexes.


Data Fields

guint value


Field Documentation

guint _AlpBundle::value
 


The documentation for this struct was generated from the following file:
Generated on Sat Dec 16 20:29:49 2006 for hiker-0.9 by  doxygen 1.4.4