/* WARNING: This file was generated by dkct. Changes you make here will be lost if dkct is run again! You should modify the original source and run dkct on it. Original source: dk4binenc.ctr */ /* Copyright (C) 2015-2017, Dirk Krause Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above opyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef DK4BINENC_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4BINENC_H_INCLUDED 1 #line 10 "dk4binenc.ctr" /** @file dk4binenc.h Encode binary data to text. */ #include "dk4error.h" #ifdef __cplusplus extern "C" { #endif /** Encode binary data to text. Data is saved as text string including finalizing 0 byte except for DK4_BINARY_TO_TEXT_ENCODING_NONE. @param dptr Destination buffer address. @param szdptr Destination buffer size. @param sptr Source buffer address. @param szsptr Source buffer size. @param enc Encoding, one from DK4_BINARY_TO_TEXT_ENCODING_NONE, DK4_BINARY_TO_TEXT_ENCODING_HEX, or DK4_BINARY_TO_TEXT_ENCODING_A85. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if dptr or sptr is NULL or szdptr or szsptr is 0 or an illegal enc value was specified, - DK4_E_BUFFER_TOO_SMALL
if the provided destination buffer is too small, - DK4_E_MATH_OVERFLOW
if a mathematical overflow occured in size calculation (required destination buffer size too large), - DK4_E_ENCODING_FAILED
if encoding failed for a byte. */ int dk4binenc( char *dptr, size_t szdptr, const void *sptr, size_t szsptr, int enc, dk4_er_t *erp ); /** Find numeric encoding type for an encoding name. @param name String containing encoding name. @param erp Error report, may be NULL. @return Non-negative numeric encoding type on success, -1 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if name is NULL, - DK4_E_SYNTAX
if name is not a valid encoding name. */ int dk4binenc_choose_encoding(const dkChar *name, dk4_er_t *erp); #ifdef __cplusplus } #endif /** Message digest encodings. */ enum { /** No encoding, use binary data directly. */ DK4_BINARY_TO_TEXT_ENCODING_NONE = 0, /** ASCII-Hex encoding. */ DK4_BINARY_TO_TEXT_ENCODING_HEX , /** ASCII-85 encoding. */ DK4_BINARY_TO_TEXT_ENCODING_A85 }; #endif