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

def pycbf::cbf_handle_struct::get_dictionary (   args  ) 

Returns : CBFHandle dictionary
*args   : 

C prototype: int cbf_get_dictionary (cbf_handle handle,
         cbf_handle * dictionary);

CBFLib documentation:
DESCRIPTION
cbf_get_dictionary sets *dictionary to the handle of a CBF which has 
been associated with the CBF handle by cbf_set_dictionary. 
cbf_set_dictionary associates the CBF handle dictionary_in with 
handle as its dictionary. cbf_require_dictionary sets *dictionary to 
the handle of a CBF which has been associated with the CBF handle by 
cbf_set_dictionary or creates a new empty CBF and associates it with 
handle, returning the new handle in *dictionary.
ARGUMENTS
handle          CBF handle. dictionary      Pointer to CBF handle of 
dictionary. dictionary_in   CBF handle of dcitionary.
RETURN VALUE
Returns an error code on failure or 0 for success. 
_________________________________________________________________

Definition at line 1310 of file pycbf.py.

01310                              :
        """
        Returns : CBFHandle dictionary
        *args   : 

        C prototype: int cbf_get_dictionary (cbf_handle handle,
                         cbf_handle * dictionary);

        CBFLib documentation:
        DESCRIPTION
        cbf_get_dictionary sets *dictionary to the handle of a CBF which has 
        been associated with the CBF handle by cbf_set_dictionary. 
        cbf_set_dictionary associates the CBF handle dictionary_in with 
        handle as its dictionary. cbf_require_dictionary sets *dictionary to 
        the handle of a CBF which has been associated with the CBF handle by 
        cbf_set_dictionary or creates a new empty CBF and associates it with 
        handle, returning the new handle in *dictionary.
        ARGUMENTS
        handle          CBF handle. dictionary      Pointer to CBF handle of 
        dictionary. dictionary_in   CBF handle of dcitionary.
        RETURN VALUE
        Returns an error code on failure or 0 for success. 
        _________________________________________________________________

        """
        return _pycbf.cbf_handle_struct_get_dictionary(*args)


Generated by  Doxygen 1.6.0   Back to index