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

def pycbf::cbf_handle_struct::require_integervalue (   args  ) 

Returns : Int number
*args   : Int thedefault

C prototype: int cbf_require_integervalue (cbf_handle handle, int *number,
         int    defaultvalue);

CBFLib documentation:
DESCRIPTION
cbf_get_integervalue sets *number to the value of the ASCII item at 
the current column and row interpreted as a decimal integer. 
cbf_require_integervalue sets *number to the value of the ASCII item 
at the current column and row interpreted as a decimal integer, 
setting it to defaultvalue if necessary.
If the value is not ASCII, the function returns CBF_BINARY.
ARGUMENTS
handle         CBF handle. number         pointer to the number. 
defaultvalue   default number value.
RETURN VALUE
Returns an error code on failure or 0 for success.
SEE ALSO

Definition at line 1630 of file pycbf.py.

01630                                    :
        """
        Returns : Int number
        *args   : Int thedefault

        C prototype: int cbf_require_integervalue (cbf_handle handle, int *number,
                         int    defaultvalue);

        CBFLib documentation:
        DESCRIPTION
        cbf_get_integervalue sets *number to the value of the ASCII item at 
        the current column and row interpreted as a decimal integer. 
        cbf_require_integervalue sets *number to the value of the ASCII item 
        at the current column and row interpreted as a decimal integer, 
        setting it to defaultvalue if necessary.
        If the value is not ASCII, the function returns CBF_BINARY.
        ARGUMENTS
        handle         CBF handle. number         pointer to the number. 
        defaultvalue   default number value.
        RETURN VALUE
        Returns an error code on failure or 0 for success.
        SEE ALSO

        """
        return _pycbf.cbf_handle_struct_require_integervalue(*args)


Generated by  Doxygen 1.6.0   Back to index