/* Copyright (C) 2011-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: dk3srch.ctr */ /** @file dk3srch.h Header file for the dk3srch module. */ #ifndef DK3SRCH_H_INCLUDED /** Avoid multiple inclusions. */ #define DK3SRCH_H_INCLUDED 1 #line 10 "dk3srch.ctr" #include "dk3conf.h" #include "dk3types.h" #ifdef __cplusplus extern "C" { #endif /** Open search structure, allocate memory. @param i Flag: Inverse sort order. @param app Application structure for diagnostics, may be NULL. @return Pointer to new structure on success, NULL on error. */ dk3_search_t * dk3search_open_app(int i, dk3_app_t *app); /** Close search structure, release memory. @param sp Search structure to close. */ void dk3search_close(dk3_search_t *sp); /** Add one result to result set. @param sp Search structure. @param fn File name to add. @return 1 on success, 0 on error (not enough memory). */ int dk3search_add(dk3_search_t *sp, dkChar const *fn); /** Reset result traversal to traverse results again. @param sp Search structure. */ void dk3search_reset(dk3_search_t *sp); /** Get next result entry. @param sp Search structure. @return Pointer to next file name or NULL. */ dkChar const * dk3search_next(dk3_search_t *sp); #ifdef __cplusplus } #endif #endif