Logo Search packages:      
Sourcecode: cbflib version File versions  Download package

def pycbf::cbf_handle_struct::find_category_root (   args  ) 

Returns : String categoryroot
*args   : String categoryname

C prototype: int cbf_find_category_root (cbf_handle handle,
         const char*    categoryname, const char** categoryroot);

CBFLib documentation:
DESCRIPTION
cbf_find_category_root sets *categoryroot to the root category of 
which categoryname is an alias. cbf_set_category_root sets 
categoryname_in as an alias of categoryroot in the dictionary 
associated with handle, creating the dictionary if necessary. 
cbf_require_category_root sets *categoryroot to the root category of 
which categoryname is an alias, if there is one, or to the value of 
categoryname, if categoryname is not an alias.
A returned categoryroot string must not be modified in any way.
ARGUMENTS
handle            CBF handle. categoryname      category name which 
may be an alias. categoryroot      pointer to a returned category 
root name. categoryroot_in   input category root name.
RETURN VALUE
Returns an error code on failure or 0 for success. 
_________________________________________________________________

Definition at line 3570 of file pycbf.py.

03570                                  :
        """
        Returns : String categoryroot
        *args   : String categoryname

        C prototype: int cbf_find_category_root (cbf_handle handle,
                         const char*    categoryname, const char** categoryroot);

        CBFLib documentation:
        DESCRIPTION
        cbf_find_category_root sets *categoryroot to the root category of 
        which categoryname is an alias. cbf_set_category_root sets 
        categoryname_in as an alias of categoryroot in the dictionary 
        associated with handle, creating the dictionary if necessary. 
        cbf_require_category_root sets *categoryroot to the root category of 
        which categoryname is an alias, if there is one, or to the value of 
        categoryname, if categoryname is not an alias.
        A returned categoryroot string must not be modified in any way.
        ARGUMENTS
        handle            CBF handle. categoryname      category name which 
        may be an alias. categoryroot      pointer to a returned category 
        root name. categoryroot_in   input category root name.
        RETURN VALUE
        Returns an error code on failure or 0 for success. 
        _________________________________________________________________

        """
        return _pycbf.cbf_handle_struct_find_category_root(*args)


Generated by  Doxygen 1.6.0   Back to index