/* 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: dk4strmf.ctr */ #ifndef DK4STRMF_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STRMF_H_INCLUDED 1 #line 10 "dk4strmf.ctr" /** @file Generic dk4_stream_t API for input and output, implementation for FILE. CRT on Windows: Required. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4STRM_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4strm.h" #else #include #endif #endif #ifndef STDIO_H_INCLUDED #include #define STDIO_H_INCLUDED 1 #endif #ifdef __cplusplus extern "C" { #endif /** Low level function to access a FILE. @param api The stream API structure for arguments and results. */ void dk4stream_file_function(dk4_stream_api_t *api); /** Low level function to access a FILE and close it on dk4stream_close(). @param api The stream API structure for arguments and results. */ void dk4stream_file_with_close_function(dk4_stream_api_t *api); /** Open a stream for an existing file. @param fipo Existing file, not closed on dk4stream_close(). @param fl Access flag: DK4_STREAM_READ, DK4_STREAM_WRITE or (DK4_STREAM_READ | DK4_STREAM_WRITE). @param ibs Input buffer size (0 for default). @param obs Output buffer size (0 for default). @param erp Error report, may be NULL. @return Pointer to stream on success, NULL on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if obj or fct is NULL or fl is invalid, - DK4_E_MATH_OVERFLOW
if ibs or obs is too large, - DK4_E_MEMORY_ALLOCATION_FAILED
if allocation of input or output buffer failed. */ dk4_stream_t * dk4stream_open_for_file( FILE *fipo, int fl, size_t ibs, size_t obs, dk4_er_t *erp ); /** Open a stream for an existing file. @param fipo Existing file, closed on dk4stream_close(). @param fl Access flag: DK4_STREAM_READ,, DK4_STREAM_WRITE or (DK4_STREAM_READ | DK4_STREAM_WRITE). @param ibs Input buffer size (0 for default). @param obs Output buffer size (0 for default). @param erp Error report, may be NULL. @return Pointer to stream on success, NULL on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if obj or fct is NULL or fl is invalid, - DK4_E_MATH_OVERFLOW
if ibs or obs is too large, - DK4_E_MEMORY_ALLOCATION_FAILED
if allocation of input or output buffer failed. */ dk4_stream_t * dk4stream_open_for_file_with_close( FILE *fipo, int fl, size_t ibs, size_t obs, dk4_er_t *erp ); #ifdef __cplusplus } #endif #endif