gbatch_holread(3)

NAME
gbatch_holread - read the holiday file

SYNOPSIS
#include <gbatch.h>

int gbatch_holread(const int fd, const unsigned flags, int year, unsigned char *bitmap)

DESCRIPTION
The function gbatch_holread is used to read the holiday file for the specified year.

fd is a file descriptor which was previously returned by a successful call to gbatch_open(3).

flags is currently unused but is reserved for future extensions.

year is the year for which the holiday file is required. This should be the actual number of the year or an offset from 1990. For example the year 1994 could be given as 1994 or 94. Note: The offset value should be less than 200.

bitmap is an array of characters representing the bitmap. Bits are set if the days is a holiday. To test the bitmap use the following formula:

 if (bitmap[day >> 3] & (1 << (day & 7)))
   /*day is holiday*/

RETURN VALUES
The function returns 0 if successful, otherwise an error code as defined in the include file \fBgbatch.h\fR.

SEE ALSO
gbatch_holupd(3).

COPYRIGHT
Copyright (c) 2009 Free Software Foundation, Inc. This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

AUTHOR
John M Collins, Xi Software Ltd.