Updated text for the KRB5_TRACE env variable.
[krb5.git] / doc / implement / crc-32-i.tex
1 The \libname{libcrc32.a} library provides an implementation of the
2 CRC-32 checksum algorithm which conforms to the interface required by
3 the Kerberos library.
4
5 \begin{funcdecl}{crc32_sum_func}{static krb5_error_code}{\funcin}
6 \funcarg{krb5_pointer}{in}
7 \funcarg{size_t}{in_length}
8 \funcarg{krb5_pointer}{seed}
9 \funcarg{size_t}{seed_length}
10 \funcout
11 \funcarg{krb5_checksum *}{outcksum}
12 \end{funcdecl}
13
14 This routine computes a CRC-32 checksum over \funcparam{in_length} bytes
15 at \funcparam{in}, and places the resulting value into
16 \funcparam{outcksum{\ptsto}contents}.  \funcparam{seed} is ignored.
17
18 \funcparam{outcksum{\ptsto}contents} must be set by the caller to point
19 to at least 4 bytes of storage.
20