/* 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: dk4filed.ctr */ #ifndef DK4FILED_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4FILED_H_INCLUDED 1 #line 10 "dk4filed.ctr" /** @file File checks. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #ifdef __cplusplus extern "C" { #endif /** Check whether a path exists. CRT on Windows: Not used. @param fn File name. @param erp Error report, may be NULL. @return 1 if file exists, 0 otherwise. Note: The function also returns 0 if it fails to obtain information about a file, i.e. due to missing permissions... Error codes: - DK4_E_NOT_SUPPORTED
if wchar_t are used on non-Windows systems, - DK4_E_INVALID_ARGUMENTS
if fn is NULL, - DK4_E_NOT_FOUND
if the specified file was not found or retrieving information failed for other reasons. */ int dk4file_exists(const dkChar *fn, dk4_er_t *erp); /** Check whether a path name specifies a regular file. CRT on Windows: Not used. @param fn File name. @param erp Error report, may be NULL. @return 1 for existing regular file, 0 otherwise. Error codes: DK4_E_NOT_SUPPORTED if wchar_t are used on non-Windows systems, DK4_E_INVALID_ARGUMENTS if fn is NULL, DK4_E_NOT_FOUND if the file does not exist or retrieving the information failed for some reason, none if the path exists but is not a regular file. */ int dk4file_is_regular(const dkChar *fn, dk4_er_t *erp); /** Check whether a path name specifies a directory. CRT on Windows: Not used. @param fn File name. @param erp Error report, may be NULL. @return 1 for existing directory, 0 otherwise. Error codes: - DK4_E_NOT_SUPPORTED
on non-Windows systems, - DK4_E_INVALID_ARGUMENTS
if fn is NULL, - DK4_E_NOT_FOUND
if the file does not exist or retrieving the information failed for some reason, - none
if the path exists but is not a directory. */ int dk4file_is_directory(const dkChar *fn, dk4_er_t *erp); #ifdef __cplusplus } #endif #endif