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

def pycbf::cbf_handle_struct::read_file (   args  ) 

Returns : 
*args   : String filename,Integer headers

C prototype: int cbf_read_file (cbf_handle handle, FILE *file, int headers);

CBFLib documentation:
DESCRIPTION
cbf_read_file reads the CBF or CIF file file into the CBF object 
specified by handle, using the CIF 1.0 convention of 80 character 
lines. cbf_read_widefile reads the CBF or CIF file file into the CBF 
object specified by handle, using the CIF 1.1 convention of 2048 
character lines. A warning is issued to stderr for ascii lines over 
the limit. No test is performed on binary sections.
Validation is performed in three ways levels: during the lexical 
scan, during the parse, and, if a dictionary was converted, against 
the value types, value enumerations, categories and parent-child 
relationships specified in the dictionary.
headers controls the interprestation of binary section headers of 
imgCIF files.
MSG_DIGEST:   Instructs CBFlib to check that the digest of the binary 
section matches any header value. If the digests do not match, the 
call will return CBF_FORMAT. This evaluation and comparison is 
delayed (a "lazy" evaluation) to ensure maximal processing 
efficiency. If an immediately evaluation is required, see 
MSG_DIGESTNOW, below. MSG_DIGESTNOW:   Instructs CBFlib to check that 
the digest of the binary section matches any header value. If the 
digests do not match, the call will return CBF_FORMAT. This 
evaluation and comparison is performed during initial parsing of the 
section to ensure timely error reporting at the expense of processing 
efficiency. If a more efficient delayed ("lazy") evaluation is 
required, see MSG_DIGESTNOW, below. MSG_NODIGEST:   Do not check the 
digest (default).
CBFlib defers reading binary sections as long as possible. In the 
current version of CBFlib, this means that:
1. The file must be a random-access file opened in binary mode (fopen

Definition at line 1387 of file pycbf.py.

01387                         :
        """
        Returns : 
        *args   : String filename,Integer headers

        C prototype: int cbf_read_file (cbf_handle handle, FILE *file, int headers);

        CBFLib documentation:
        DESCRIPTION
        cbf_read_file reads the CBF or CIF file file into the CBF object 
        specified by handle, using the CIF 1.0 convention of 80 character 
        lines. cbf_read_widefile reads the CBF or CIF file file into the CBF 
        object specified by handle, using the CIF 1.1 convention of 2048 
        character lines. A warning is issued to stderr for ascii lines over 
        the limit. No test is performed on binary sections.
        Validation is performed in three ways levels: during the lexical 
        scan, during the parse, and, if a dictionary was converted, against 
        the value types, value enumerations, categories and parent-child 
        relationships specified in the dictionary.
        headers controls the interprestation of binary section headers of 
        imgCIF files.
        MSG_DIGEST:   Instructs CBFlib to check that the digest of the binary 
        section matches any header value. If the digests do not match, the 
        call will return CBF_FORMAT. This evaluation and comparison is 
        delayed (a "lazy" evaluation) to ensure maximal processing 
        efficiency. If an immediately evaluation is required, see 
        MSG_DIGESTNOW, below. MSG_DIGESTNOW:   Instructs CBFlib to check that 
        the digest of the binary section matches any header value. If the 
        digests do not match, the call will return CBF_FORMAT. This 
        evaluation and comparison is performed during initial parsing of the 
        section to ensure timely error reporting at the expense of processing 
        efficiency. If a more efficient delayed ("lazy") evaluation is 
        required, see MSG_DIGESTNOW, below. MSG_NODIGEST:   Do not check the 
        digest (default).
        CBFlib defers reading binary sections as long as possible. In the 
        current version of CBFlib, this means that:
        1. The file must be a random-access file opened in binary mode (fopen

        """
        return _pycbf.cbf_handle_struct_read_file(*args)


Generated by  Doxygen 1.6.0   Back to index