/* Copyright (C) 2012-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: dk3ufi.ctr */ /** @file dk3ufi.h Header file for the dk3ufi module. */ #ifndef DK3UFI_H_INCLUDED /** Avoid multiple inclusions. */ #define DK3UFI_H_INCLUDED 1 #line 9 "dk3ufi.ctr" #include "dk3types.h" /** Unique file identifier. If two files produce the same UFI they are both links to the same file or different file name notations pointing to the same file, i.e. "x.txt" and "./x.txt". */ typedef struct { #if DK3_ON_WINDOWS DWORD volser; /**< Volume serial number. */ DWORD indhigh; /**< Higner index part. */ DWORD indlow; /**< Lower index part. */ #else dk3_um_t device; /**< Device number. */ dk3_um_t inode; /**< Inode number. */ #endif } dk3_ufi_t; #ifdef __cplusplus extern "C" { #endif /** Obtain unique identifier for file. @param pd Result buffer pointer. @param fn File name to check. @param app Application structure for diagnostics, may be NULL. @return 1 on success, 0 on error. */ int dk3ufi_get_app(dk3_ufi_t *pd, dkChar const *fn, dk3_app_t *app); /** Obtain unique identifier for file. @param pd Result buffer pointer. @param fn File name to check (8-bit character string). @param app Application structure for diagnostics, may be NULL. @return 1 on success, 0 on error. */ int dk3ufi_c8_get_app(dk3_ufi_t *pd, char const *fn, dk3_app_t *app); /** Obtain unique identifier for file. @param pd Result buffer pointer. @param fn File name to check. @return 1 on success, 0 on error. */ int dk3ufi_get(dk3_ufi_t *pd, dkChar const *fn); /** Obtain unique identifier for file. @param pd Result buffer pointer. @param fn File name to check (8-bit character string). @return 1 on success, 0 on error. */ int dk3ufi_c8_get(dk3_ufi_t *pd, char const *fn); /** Compare two file identifiers. @param l Left identifier. @param r Right identifier. @param cr Comparison criteria (ignored). @return Comparison result. */ int dk3ufi_compare(void const *l, void const *r, int cr); #ifdef __cplusplus } #endif #endif