d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence/*
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * Copyright (C) 2000, 2001, 2004-2007, 2013, 2016 Internet Systems Consortium, Inc. ("ISC")
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence *
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * This Source Code Form is subject to the terms of the Mozilla Public
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * License, v. 2.0. If a copy of the MPL was not distributed with this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * file, You can obtain one at http://mozilla.org/MPL/2.0/.
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
70e5a7403f0e0a3bd292b8287c5fed5772c15270Automatic Updater/* $Id: stdio.h,v 1.13 2007/06/19 23:47:18 tbox Exp $ */
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence#ifndef ISC_STDIO_H
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence#define ISC_STDIO_H 1
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/*! \file isc/stdio.h */
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein
2777329775a039bea0ec3142a3e3158d9441fc75Tinderbox User/*%
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * These functions are wrappers around the corresponding stdio functions.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * They return a detailed error code in the form of an an isc_result_t. ANSI C
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * does not guarantee that stdio functions set errno, hence these functions
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * must use platform dependent methods (e.g., the POSIX errno) to construct the
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * error code.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein */
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence#include <stdio.h>
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence#include <isc/lang.h>
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence#include <isc/result.h>
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ac9e556e494750eb6e454c337d6632fa395f24d8David LawrenceISC_LANG_BEGINDECLS
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Open */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_open(const char *filename, const char *mode, FILE **fp);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Close */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_close(FILE *f);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Seek */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Huntisc_stdio_seek(FILE *f, off_t offset, int whence);
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt/*% Tell */
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Huntisc_result_t
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Huntisc_stdio_tell(FILE *f, off_t *offsetp);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Read */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_read(void *ptr, size_t size, size_t nmemb, FILE *f,
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence size_t *nret);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Write */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_write(const void *ptr, size_t size, size_t nmemb, FILE *f,
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence size_t *nret);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*% Flush */
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_flush(FILE *f);
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_result_t
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrenceisc_stdio_sync(FILE *f);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence * Invoke fsync() on the file descriptor underlying an stdio stream, or an
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence * equivalent system-dependent operation. Note that this function has no
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence * direct counterpart in the stdio library.
d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence */
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence
ac9e556e494750eb6e454c337d6632fa395f24d8David LawrenceISC_LANG_ENDDECLS
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence
ac9e556e494750eb6e454c337d6632fa395f24d8David Lawrence#endif /* ISC_STDIO_H */