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 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23
  24 #ifndef INCLUDED_RTL_CRC_H
  25 #define INCLUDED_RTL_CRC_H
  26
  27 #include "sal/config.h"
  28
  29 #include "sal/saldllapi.h"
  30 #include "sal/types.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /** Evaluate CRC32 over given data.
  37
  38     This function evaluates the CRC polynomial 0xEDB88320.
  39
  40     @param[in] Crc    CRC32 over previous data or zero.
  41     @param[in] Data   data buffer.
  42     @param[in] DatLen data buffer length.
  43     @return new CRC32 value.
  44  */
  45 SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_crc32 (
  46     sal_uInt32  Crc,
  47     const void *Data, sal_uInt32 DatLen
  48 ) SAL_THROW_EXTERN_C();
  49
  50 #ifdef __cplusplus
  51 }
  52 #endif
  53
  54 #endif // INCLUDED_RTL_CRC_H
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */