libsdfio/file_8h_source.html

/*

 * SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>

 *

 * SPDX-License-Identifier: MIT

 */


#ifndef SDFIO_FILE_H

#define SDFIO_FILE_H


#include <sdfio/reader.h>

#include <sdfio/sdfio_export.h>

#include <sdfio/types.h>

#include <sdfio/writer.h>


#include <stdio.h>

#include <wchar.h>


#ifdef __cplusplus

extern "C"

{

#endif


SDFIO_API void sdfio_stdio_stream(sdfio_stream *stream, FILE *file);


SDFIO_API sdfio_status sdfio_open_file(sdfio_reader *reader, const char *path);


SDFIO_API sdfio_status sdfio_create_file(sdfio_writer *writer, const char *path,

                                         const sdfio_header *header);


#if defined(_WIN32)

SDFIO_API sdfio_status sdfio_open_wfile(sdfio_reader *reader,

                                        const wchar_t *path);


SDFIO_API sdfio_status sdfio_create_wfile(sdfio_writer *writer,

                                          const wchar_t *path,

                                          const sdfio_header *header);

#endif


#ifdef __cplusplus

}

#endif


#endif

sdfio_create_wfile
sdfio_status sdfio_create_wfile(sdfio_writer *writer, const wchar_t *path, const sdfio_header *header)
Variant of sdfio_create_file() with a path of wide characters.

sdfio_stdio_stream
void sdfio_stdio_stream(sdfio_stream *stream, FILE *file)
Creates a stream over a C file.

sdfio_open_file
sdfio_status sdfio_open_file(sdfio_reader *reader, const char *path)
Opens the file at a path as the source and reads its header, as sdfio_open_stream() does for a stream...

sdfio_open_wfile
sdfio_status sdfio_open_wfile(sdfio_reader *reader, const wchar_t *path)
Variant of sdfio_open_file() with a path of wide characters.

sdfio_create_file
sdfio_status sdfio_create_file(sdfio_writer *writer, const char *path, const sdfio_header *header)
Creates the file at a path and starts it as sdfio_create_stream() does.

sdfio_header
struct sdfio_header sdfio_header
Header of a file, with the field names of the standard.
Definition header.h:42

reader.h
Reader of a file, memory or a stream.

sdfio_reader
struct sdfio_reader sdfio_reader
Opaque handle of a reader.
Definition reader.h:58

sdfio_stream
Callbacks that provide or accept the bytes of a file.
Definition types.h:213

types.h
Status codes, enumerations, constants, and the structures for allocator, stream and time zone.

sdfio_status
sdfio_status
Result of a function call.
Definition types.h:31

writer.h
Writer of a file or a stream.

sdfio_writer
struct sdfio_writer sdfio_writer
Opaque handle of a writer.
Definition writer.h:69