sal/inc/rtl/crc.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: crc.h,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _RTL_CRC_H_
  32 #define _RTL_CRC_H_ "$Revision: 1.4 $"
  33
  34 #include <sal/types.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*========================================================================
  41  *
  42  * rtl_crc32 interface.
  43  *
  44  *======================================================================*/
  45 /** Evaluate CRC32 over given data.
  46     @descr This function evaluates the CRC polynomial 0xEDB88320.
  47
  48     @param  Crc    [in] CRC32 over previous data or zero.
  49     @param  Data   [in] data buffer.
  50     @param  DatLen [in] data buffer length.
  51     @return new CRC32 value.
  52  */
  53 sal_uInt32 SAL_CALL rtl_crc32 (
  54     sal_uInt32  Crc,
  55     const void *Data, sal_uInt32 DatLen
  56 ) SAL_THROW_EXTERN_C();
  57
  58 /*========================================================================
  59  *
  60  * The End.
  61  *
  62  *======================================================================*/
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif /* _RTL_CRC_H_ */
  69