note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

filecrc

warning

This function was added in omp v1.1.0.2612 and will not work in earlier versions!

warning

This function starts with a lowercase letter.

Description

Return the 32-bit CRC value of a file.

Name	Description
const filename[]	The name of the file.

Returns

The 32-bit CRC value of the file, or 0 if the file cannot be opened.

Examples

new crc = filecrc("file.txt");

if (crc)
{
    // Success
    printf("CRC value = %d", crc);
}
else
{
    // Error
    print("The file \"file.txt\" does not exists, or can't be opened.");
}

Notes

tip

The CRC value is a useful measure to check whether the contents of a file has changed during transmission or whether it has been edited (provided that the CRC value of the original file was saved).
The CRC value returned by this function is the same as the one used in ZIP archives (PKZip, WinZip) and the "SFV" utilities and file formats.

Related Functions

fopen: Open a file.
fclose: Close a file.
ftemp: Create a temporary file stream.
fremove: Remove a file.
fwrite: Write to a file.
fputchar: Put a character in a file.
fgetchar: Get a character from a file.
fblockwrite: Write blocks of data into a file.
fblockread: Read blocks of data from a file.
fseek: Jump to a specific character in a file.
flength: Get the file length.
fexist: Check, if a file exists.
fmatch: Check, if patterns with a file name matches.
ftell: Get the current position in the file.
fflush: Flush a file to disk (ensure all writes are complete).
fstat: Return the size and the timestamp of a file.
frename: Rename a file.
fcopy: Copy a file.
diskfree: Returns the free disk space.
fattrib: Set the file attributes.
fcreatedir: Create a directory.