Files
harbour-core/harbour/doc/en/hb_date.txt

481 lines
7.6 KiB
Plaintext

/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://www.harbour-project.org
*
* Copyright 1999-2001 Viktor Szakats <viktor.szakats@syenar.hu>
* Header file for the Date API
*
* See doc/license.txt for licensing terms.
*
*/
/* $DOC$
* $FUNCNAME$
* hb_dateSeconds()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateSeconds( void ) --> ( double )dResult
* $ARGUMENTS$
*
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateToday()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateToday( long * plYear, long * plMonth, long * plDay ) --> void
* $ARGUMENTS$
* <plYear>
*
* <plMonth>
*
* <plDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateTimeStr()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateTimeStr( char * pszTime ) --> void
* $ARGUMENTS$
* <pszTime>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateCMonth()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateCMonth( int iMonth ) --> ( char * )pszResult
* $ARGUMENTS$
* <iMonth>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateCDOW()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateCDOW( int iDay ) --> ( char * )pszResult
* $ARGUMENTS$
* <iDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateDOW()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateDOW( long lYear, long lMonth, long lDay ) --> ( long )lResult
* $ARGUMENTS$
* <lYear>
*
* <lMonth>
*
* <lDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateFormat()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateFormat( const char * szDate, char * szFormattedDate, const char * szDateFormat ) --> ( char * )pszResult
* $ARGUMENTS$
* <szDate>
*
* <szFormattedDate>
*
* <szDateFormat>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateEncode()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateEncode( long lYear, long lMonth, long lDay ) --> ( long )lResult
* $ARGUMENTS$
* <lYear>
*
* <lMonth>
*
* <lDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateDecode()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateDecode( long julian, long * plYear, long * plMonth, long * plDay ) --> void
* $ARGUMENTS$
* <julian>
*
* <plYear>
*
* <plMonth>
*
* <plDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateStrPut()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateStrPut( char * szDate, long lYear, long lMonth, long lDay ) --> void
* $ARGUMENTS$
* <szDate>
*
* <lYear>
*
* <lMonth>
*
* <lDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateStrGet()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateStrGet( const char * szDate, long * plYear, long * plMonth, long * plDay ) --> void
* $ARGUMENTS$
* <szDate>
*
* <plYear>
*
* <plMonth>
*
* <plDay>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateDecStr()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateDecStr( char * szDate, long lJulian ) --> ( char * )pszResult
* $ARGUMENTS$
* <szDate>
*
* <lJulian>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* hb_dateEncStr()
* $CATEGORY$
* Date API
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include <hbdate.h>
* hb_dateEncStr( char * szDate ) --> ( long )lResult
* $ARGUMENTS$
* <szDate>
* $RETURNS$
*
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* Compliance is not applicable to API calls.
* $FILES$
* Library is rtl
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/