/* 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: dk4strmh.ctr */ #ifndef DK4STRMH_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STRMH_H_INCLUDED 1 #line 10 "dk4strmh.ctr" /** @file Generic dk4_stream_t API for input from Windows file handle. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #if DK4_ON_WINDOWS #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef WINDOWS_H_INCLUDED #include #define WINDOWS_H_INCLUDED 1 #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.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 /** Structure for keeping a HANDLE. */ typedef struct { HANDLE ha; /**< Windows file handle. */ int feof; /**< Flag: Found EOF while reading. */ } dk4_stream_handle_t; #ifdef __cplusplus extern "C" { #endif /** Low level function to access a Windows handle. @param api The stream API structure for arguments and results. */ void dk4stream_windows_handle_function(dk4_stream_api_t *api); /** Low level function to access a Windows handle and close it on dk4stream_close(). @param api The stream API structure for arguments and results. */ void dk4stream_windows_handle_with_close_function(dk4_stream_api_t *api); /** Open a stream for an existing handle. @param ha Existing file handle, 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 new stream on success, NULL on error. */ dk4_stream_t * dk4stream_open_for_windows_handle( HANDLE ha, int fl, size_t ibs, size_t obs, dk4_er_t *erp ); /** Open a stream for an existing handle. @param ha Existing file handle, 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 new stream on success, NULL on error. */ dk4_stream_t * dk4stream_open_for_windows_handle_with_close( HANDLE ha, int fl, size_t ibs, size_t obs, dk4_er_t *erp ); #ifdef __cplusplus } #endif #endif #endif