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

def pycbf::cbf_handle_struct::get_diffrn_id (   args  ) 

Returns : 
*args   : string

C prototype: int cbf_get_diffrn_id (cbf_handle handle,
         const char **diffrn_id);

CBFLib documentation:
DESCRIPTION
cbf_get_diffrn_id sets *diffrn_id to point to the ASCII value of the 
"diffrn.id" entry. cbf_require_diffrn_id also sets *diffrn_id to 
point to the ASCII value of the "diffrn.id" entry, but, if the 
"diffrn.id" entry does not exist, it sets the value in the CBF and 
in*diffrn_id to the character string given by default_id, creating 
the category and column is necessary.
The diffrn_id will be valid as long as the item exists and has not 
been set to a new value.
The diffrn_id must not be modified by the program in any way.
ARGUMENTS
handle       CBF handle. diffrn_id    Pointer to the destination 
value pointer. default_id   Character string default value.
RETURN VALUE
Returns an error code on failure or 0 for success. 
_________________________________________________________________

Definition at line 1281 of file pycbf.py.

01281                             :
        """
        Returns : 
        *args   : string

        C prototype: int cbf_get_diffrn_id (cbf_handle handle,
                         const char **diffrn_id);

        CBFLib documentation:
        DESCRIPTION
        cbf_get_diffrn_id sets *diffrn_id to point to the ASCII value of the 
        "diffrn.id" entry. cbf_require_diffrn_id also sets *diffrn_id to 
        point to the ASCII value of the "diffrn.id" entry, but, if the 
        "diffrn.id" entry does not exist, it sets the value in the CBF and 
        in*diffrn_id to the character string given by default_id, creating 
        the category and column is necessary.
        The diffrn_id will be valid as long as the item exists and has not 
        been set to a new value.
        The diffrn_id must not be modified by the program in any way.
        ARGUMENTS
        handle       CBF handle. diffrn_id    Pointer to the destination 
        value pointer. default_id   Character string default value.
        RETURN VALUE
        Returns an error code on failure or 0 for success. 
        _________________________________________________________________

        """
        return _pycbf.cbf_handle_struct_get_diffrn_id(*args)


Generated by  Doxygen 1.6.0   Back to index