/* Copyright (C) 2015-2020, Dirk Krause SPDX-License-Identifier: BSD-3-Clause */ /* WARNING: This file was generated by the dkct program (see http://dktools.sourceforge.net/ for details). 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 */ #ifndef DK4BINENC_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4BINENC_H_INCLUDED 1 #line 10 "dk4binenc.ctr" /** @file dk4binenc.h Encode binary data to text. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #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