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

def pycbf::cbf_handle_struct::require_value (   args  ) 

Returns : String Value
*args   : String defaultvalue

C prototype: int cbf_require_value (cbf_handle handle, const char **value,
         const    char *defaultvalue );

CBFLib documentation:
DESCRIPTION
cbf_get_value sets *value to point to the ASCII value of the item at 
the current column and row. cbf_set_value sets *value to point to the 
ASCII value of the item at the current column and row, creating the 
data item if necessary and initializing it to a copy of defaultvalue.
If the value is not ASCII, the function returns CBF_BINARY.
The value will be valid as long as the item exists and has not been 
set to a new value.
The value must not be modified by the program in any way.
ARGUMENTS
handle   CBF handle. value    Pointer to the destination value 
pointer. value    Default value character string.
RETURN VALUE
Returns an error code on failure or 0 for success.
SEE ALSO

Definition at line 2237 of file pycbf.py.

02237                             :
        """
        Returns : String Value
        *args   : String defaultvalue

        C prototype: int cbf_require_value (cbf_handle handle, const char **value,
                         const    char *defaultvalue );

        CBFLib documentation:
        DESCRIPTION
        cbf_get_value sets *value to point to the ASCII value of the item at 
        the current column and row. cbf_set_value sets *value to point to the 
        ASCII value of the item at the current column and row, creating the 
        data item if necessary and initializing it to a copy of defaultvalue.
        If the value is not ASCII, the function returns CBF_BINARY.
        The value will be valid as long as the item exists and has not been 
        set to a new value.
        The value must not be modified by the program in any way.
        ARGUMENTS
        handle   CBF handle. value    Pointer to the destination value 
        pointer. value    Default value character string.
        RETURN VALUE
        Returns an error code on failure or 0 for success.
        SEE ALSO

        """
        return _pycbf.cbf_handle_struct_require_value(*args)


Generated by  Doxygen 1.6.0   Back to index