Click above to get retro games delivered to your door ever month!

SCREENFILE()

Syntax:     SCREENFILE(<expC>[,<expL>][,<expN>])

Arguments:  <expC> denotes the name and path of the screen file.
            <expL> will determine whether it is required to append to an
            existing file (.T.) or whether it should be overwritten (.F.)
            (default: (.F.)).
            <expN> corresponds to the offset in the file where the
            screen will be written if the argument <expL> is (.T.) (default:
            end of file).

Returns:    A numeric value.
            The number of bytes written.

Usage:      SCREENFILE() allows the sequential storage of Clipper
            screens to a file, in the same format as SAVE SCREEN.

Notes:      It is only possible to use the argument <expN> when <expL>
            is specified at the same time.  <expN> denotes the position in
            the screen file where it is required to write the new screen
            data.  Overwriting occurs if the position determined by
            <expN> is located before the end.  If the position is beyond
            the end of the file, then the data is simply appended.  It is
            thus possible to store several screens in one file.

            If CSETSAFTY() flag (internal to Clipper Tools One) has
            been switched on, the targeted file will not be overwritten
            even if <expL> is (.T.).

Library:    CT1.LIB


--------------------------------- Example ------------------------------

Examples:   * An existing file is overwritten.
            SCREENFILE("screen.tst")            && Result: 4000
            SCREENFILE("\screen.tst")           && Result: 4000
            SCREENFILE("a:\screen.tst")         && Result: 4000

            * Add another screen to the same file.
            SCREENFILE("screen.tst",.T.)        && Result: 8000

            * Overwrite second screen in file.
            SCREENFILE("screen.tst",.T.,8000)   && Result: 8000

            * Overwrite third screen in file.
            SCREENFILE("screen.tst",.T.,12000)  && Result: 12000

            * Wildcards are not allowed.
            SCREENFILE("screen.*")              && Result: 0