/* Copyright (C) 2016-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: dk4userf.ctr */ #ifndef DK4USERF_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4USERF_H_INCLUDED 1 #line 10 "dk4userf.ctr" /** @file dk4userf.h Unserialize (read) data from binary file. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #if DK4_HAVE_STDLIB_H #ifndef DK4_STDLIB_H_INCLUDED #include #define DK4_STDLIB_H_INCLUDED 1 #endif #endif #if DK4_HAVE_SYS_TYPES_H #ifndef DK4_SYS_TYPES_H_INCLUDED #include #define DK4_SYS_TYPES_H_INCLUDED 1 #endif #endif #if DK4_HAVE_STDINT_H #ifndef DK4_STDINT_H_INCLUDED #include #define DK4_STDINT_H_INCLUDED 1 #endif #endif #include #ifdef __cplusplus extern "C" { #endif /** Unserialize (read) a 16 bit unsigned number from binary file. @param dptr Address of destination variable. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_uint16_t(uint16_t *dptr, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) a 16 bit signed number from binary file. @param dptr Address of destination variable. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_int16_t(int16_t *dptr, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) a 32 bit unsigned number from binary file. @param dptr Address of destination variable. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_uint32_t(uint32_t *dptr, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) a 32 bit signed number from binary file. @param dptr Address of destination variable. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_int32_t(int32_t *dptr, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) an UTF-8 encoded text string from binary file. On success the function dynamically allocates memory for the string and sets the pointer to this memory. Use dk4mem_free() to release the memory after use. @param dptr Address of destination pointer variable, initialize the pointer to NULL before calling this function. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_utf8_string(char **dptr, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) a text string in the system default encoding from binary file. On success the function dynamically allocates memory for the string and sets the pointer to this memory. Use dk4mem_free() to release the memory after use. @param dptr Address of destination pointer variable, initialize the pointer to NULL before calling this function. @param de Encoding for dkChar. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_dk_string(dkChar **dptr, int de, FILE *fipo, dk4_er_t *erp); /** Unserialize (read) a double number from binary file. @param dptr Address of destination variable. @param fipo Input file (opened for binary read access). @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4unserialize_file_double(double *dptr, FILE *fipo, dk4_er_t *erp); #ifdef __cplusplus } #endif #endif