[thirdparty/cups.git] / cups / dir.h

/*
 * "$Id$"
 *
 *   Public directory definitions for the Common UNIX Printing System (CUPS).
 *
 *   This set of APIs abstracts enumeration of directory entries.
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE.txt" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */

#ifndef _CUPS_DIR_H_
#  define _CUPS_DIR_H_


/*
 * Include necessary headers...
 */

#  include <sys/stat.h>


/*
 * C++ magic...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * Data types...
 */

typedef struct _cups_dir_s cups_dir_t;	/**** Directory type ****/

typedef struct cups_dentry_s		/**** Directory entry type ****/
{
  char		filename[260];		/* File name */
  struct stat	fileinfo;		/* File information */
} cups_dentry_t;


/*
 * Prototypes...
 */

extern void		cupsDirClose(cups_dir_t *dp);
extern cups_dir_t	*cupsDirOpen(const char *directory);
extern cups_dentry_t	*cupsDirRead(cups_dir_t *dp);
extern void		cupsDirRewind(cups_dir_t *dp);


#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_DIR_H_ */

/*
 * End of "$Id$".
 */
Commit	Line	Data
ef416fc2	1	/*
f7faf1f5	2	* "$Id$"
ef416fc2	3	*
	4	* Public directory definitions for the Common UNIX Printing System (CUPS).
	5	*
	6	* This set of APIs abstracts enumeration of directory entries.
	7	*
d09495fa	8	* Copyright 1997-2006 by Easy Software Products, all rights reserved.
ef416fc2	9	*
	10	* These coded instructions, statements, and computer programs are the
	11	* property of Easy Software Products and are protected by Federal
	12	* copyright law. Distribution and use rights are outlined in the file
	13	* "LICENSE.txt" which should have been included with this file. If this
	14	* file is missing or damaged please contact Easy Software Products
	15	* at:
	16	*
	17	* Attn: CUPS Licensing Information
	18	* Easy Software Products
	19	* 44141 Airport View Drive, Suite 204
	20	* Hollywood, Maryland 20636 USA
	21	*
	22	* Voice: (301) 373-9600
	23	* EMail: cups-info@cups.org
	24	* WWW: http://www.cups.org
	25	*/
	26
	27	#ifndef _CUPS_DIR_H_
	28	# define _CUPS_DIR_H_
	29
	30
	31	/*
	32	* Include necessary headers...
	33	*/
	34
	35	# include <sys/stat.h>
	36
	37
	38	/*
	39	* C++ magic...
	40	*/
	41
d09495fa	42	# ifdef __cplusplus
ef416fc2	43	extern "C" {
d09495fa	44	# endif /* __cplusplus */
ef416fc2	45
	46
	47	/*
	48	* Data types...
	49	*/
	50
	51	typedef struct _cups_dir_s cups_dir_t; /** Directory type **/
	52
	53	typedef struct cups_dentry_s /** Directory entry type **/
	54	{
	55	char filename[260]; /* File name */
	56	struct stat fileinfo; /* File information */
	57	} cups_dentry_t;
	58
	59
	60	/*
	61	* Prototypes...
	62	*/
	63
	64	extern void cupsDirClose(cups_dir_t *dp);
	65	extern cups_dir_t cupsDirOpen(const char directory);
	66	extern cups_dentry_t cupsDirRead(cups_dir_t dp);
	67	extern void cupsDirRewind(cups_dir_t *dp);
	68
	69
d09495fa	70	# ifdef __cplusplus
ef416fc2	71	}
d09495fa	72	# endif /* __cplusplus */
ef416fc2	73	#endif /* !_CUPS_DIR_H_ */
	74
	75	/*
f7faf1f5	76	* End of "$Id$".
ef416fc2	77	*/