include/rtl/crc.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_RTL_CRC_H
  21 #define INCLUDED_RTL_CRC_H
  22
  23 #include <sal/config.h>
  24
  25 #include <sal/saldllapi.h>
  26 #include <sal/types.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*========================================================================
  33  *
  34  * rtl_crc32 interface.
  35  *
  36  *======================================================================*/
  37 /** Evaluate CRC32 over given data.
  38
  39     This function evaluates the CRC polynomial 0xEDB88320.
  40
  41     @param  Crc    [in] CRC32 over previous data or zero.
  42     @param  Data   [in] data buffer.
  43     @param  DatLen [in] data buffer length.
  44     @return new CRC32 value.
  45  */
  46 SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_crc32 (
  47     sal_uInt32  Crc,
  48     const void *Data, sal_uInt32 DatLen
  49 ) SAL_THROW_EXTERN_C();
  50
  51 /*========================================================================
  52  *
  53  * The End.
  54  *
  55  *======================================================================*/
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif // INCLUDED_RTL_CRC_H
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */