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

def pycbf::cbf_handle_struct::get_element_id (   args  ) 

Returns : String
*args   : Integer element_number

C prototype: int cbf_get_element_id (cbf_handle handle,
         unsigned int    element_number, const char **element_id);

CBFLib documentation:
DESCRIPTION
cbf_get_element_id sets *element_id to point to the ASCII value of 
the element_number th "diffrn_data_frame.detector_element_id" 
entry, counting from 0.
If the detector element does not exist, the function returns 
CBF_NOTFOUND.
The element_id will be valid as long as the item exists and has not 
been set to a new value.
The element_id must not be modified by the program in any way.
ARGUMENTS
handle   CBF handle. element_number   The number of the detector 
element counting from 0 by order of appearance in the 
"diffrn_data_frame" category. element_id   Pointer to the 
destination.
RETURN VALUE
Returns an error code on failure or 0 for success. 
_________________________________________________________________

Definition at line 3351 of file pycbf.py.

03351                              :
        """
        Returns : String
        *args   : Integer element_number

        C prototype: int cbf_get_element_id (cbf_handle handle,
                         unsigned int    element_number, const char **element_id);

        CBFLib documentation:
        DESCRIPTION
        cbf_get_element_id sets *element_id to point to the ASCII value of 
        the element_number th "diffrn_data_frame.detector_element_id" 
        entry, counting from 0.
        If the detector element does not exist, the function returns 
        CBF_NOTFOUND.
        The element_id will be valid as long as the item exists and has not 
        been set to a new value.
        The element_id must not be modified by the program in any way.
        ARGUMENTS
        handle   CBF handle. element_number   The number of the detector 
        element counting from 0 by order of appearance in the 
        "diffrn_data_frame" category. element_id   Pointer to the 
        destination.
        RETURN VALUE
        Returns an error code on failure or 0 for success. 
        _________________________________________________________________

        """
        return _pycbf.cbf_handle_struct_get_element_id(*args)


Generated by  Doxygen 1.6.0   Back to index