/*
 * libexplain - a library of system-call-specific strerror replacements
 * Copyright (C) 2013 Peter Miller
 * Written by Peter Miller <pmiller@opensource.org.au>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBEXPLAIN_FILDES_IS_DOT_H
#define LIBEXPLAIN_FILDES_IS_DOT_H

/**
  * The explain_fildes_is_dot function may be used to determin whether a
  * given file descritor refers to the current directory.
  *
  * @param fildes
  *    The file descriptor to be checked.
  * @returns
  *    int; 0 (false) if fildes does not refer to the currnt directory;
  *         non-zero (true) if files does refer to th currnt directory.
  * @note
  *    If there are any errors, it will just return 0 (false).
  */
int explain_fildes_is_dot(int fildes);

/* vim: set ts=8 sw=4 et : */
#endif /* LIBEXPLAIN_FILDES_IS_DOT_H */
