/* 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: dk4strmo32.ctr */ #ifndef DK4STRMO32_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STRMO32_H_INCLUDED 1 #line 9 "dk4strmo32.ctr" /** @file String output over dk4_stream_t API, 32 bit character strings. CRT on Windows: Not used. */ #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 #ifdef __cplusplus extern "C" { #endif /** Set output encoding for 32 bit character output. @param strm Stream to modify. @param oe New output encoding. */ void dk4stream_set_output_encoding(dk4_stream_t *strm, int oe); /** Write one 32 bit character to stream. @param strm Stream to write to. @param c32 Character to write. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is null or not set up for writing, - DK4_E_ENCODING_FAILED
if it is not possible to encode c32 to the output encoding for the stream, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flushing data downwards failed. */ int dk4stream_c32_putc(dk4_stream_t *strm, dk4_c32_t c32, dk4_er_t *erp); /** Write one 32 bit character string to stream. @param strm Stream to write to. @param txt Text string to write. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is null or not set up for writing, - DK4_E_ENCODING_FAILED
if it is not possible to encode c32 to the output encoding for the stream, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flushing data downwards failed. */ int dk4stream_c32_puts(dk4_stream_t *strm, const dk4_c32_t *txt, dk4_er_t *erp); /** Write byte order marker for those output encodings supporting a BOM. @param strm Stream to write the BOM to. @param erp Error report, may be NULL. @return 1 on success (BOM written or not required), 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is null or not set up for writing, - DK4_E_ENCODING_FAILED
if it is not possible to encode c32 to the output encoding for the stream, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flushing data downwards failed. */ int dk4stream_write_bom_if_necessary(dk4_stream_t *strm, dk4_er_t *erp); #ifdef __cplusplus } #endif #endif