This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
magicka/jamlib-1.4.7/doc/JAM_Crc32.3
2016-03-22 12:08:00 +10:00

43 lines
1021 B
Groff

.\" $Id: JAM_Crc32.3,v 1.1 2002/11/09 00:37:16 raorn Exp $
.\"
.TH JAM_Crc32 3 2002-11-07 "" "JAM subroutine library"
.SH NAME
JAM_Crc32 \- Calculate CRC32 on a block of data
.SH SYNOPSIS
.nf
.B #include <jamlib/jam.h>
.BI "ulong JAM_Crc32(uchar* " Buffer_PC ","
.BI " ulong " Length_I ");"
.RE
.fi
.SH DESCRIPTION
Calculates the Crc32 value for a block of data. All ASCII
characters are converted to lowercase before calculating
the CRC (the input data is unchanged).
.SS Arguments
.TP
.I Buffer_PC
A pointer to the first byte of the data block
.TP
.I Length_I
The number of bytes in the data block
.SH "RETURN VALUE"
The Crc32 value
.SH EXAMPLES
.nf
ulong Crc_I;
uchar Text_AC[32];
strcpy(Text_AC, "Hello world!\\n");
Crc_I = JAM_Crc32(Text_AC, strlen(Text_AC));
.fi
.SH AUTHOR
This manual page was created by Sir Raorn <raorn@altlinux.ru>,
based on original JAMlib documentation by Bjorn Stenberg
<bjorn@haxx.nu> and Johan Billing <billing@df.lth.se>.
.SH SEE ALSO
.BR jamlib (3)
.\" vim: ft=nroff