Calendar based Calculations.

functions for calendar-based date calculations. More...

Functions
int __stdcall	SFDB_ISVALIDCALCODE (LPCTSTR argCode)
	Examine the given code as a valid/supported calendar code.
int __stdcall	SFDB_CALNAME (LPCTSTR argCode, LPTSTR retVal, size_t *nLen)
	Returns the calendar name and description, given the calendar's short code (e.g., "US" will return "US Government Holidays").
int __stdcall	SFDB_CALENDARS (LPCTSTR argName, LPTSTR retVal, size_t *nLen, LPWORD nNumber)
	Returns an array of names and codes for the supported calendars.
int __stdcall	SFDB_CALHLDYS (LPCTSTR argCalCode, LPTSTR retVal, size_t *nLen, LPWORD nNumber)
	Returns an array of the holidays' names and codes as defined for the given calendar.
int __stdcall	SFDB_CALWKND (LPCTSTR argCalCode, LPWORD nWKNDNo)
	Returns the weekend number associated with the given calendar.

Detailed Description

Function Documentation

SFDB_CALENDARS()

int __stdcall SFDB_CALENDARS	(	LPCTSTR	argName,
		LPTSTR	retVal,
		size_t *	nLen,
		LPWORD	nNumber )

Parameters

[in]	argName	(Required) the name or prefix of the calendar name. If missing, all supported calendars will be returned.
[out]	retVal	(Required) The buffer that will receive the comma-separated calendar codes
[in,out]	nLen	(Required) The maximum number of characters to copy to the buffer.
[out]	nNumber	(Required) the number of matching calendars

Returns

status code of the function call: zero = success, positive = success with a warning, and negative = error occurred.

Return values

NDK_SUCCESS	success
NDK_FAILED	error

See also

SFDB_ISWRKDY()

returns the list of calendars codes.

Remarks

Example

Requirements

Target Platform	Windows
Header	SFDBM.h (include Windows.h)
Library	SFDBM.lib
DLL	SFDBM.dll

Since

v1.68

SFDB_CALHLDYS()

int __stdcall SFDB_CALHLDYS	(	LPCTSTR	argCalCode,
		LPTSTR	retVal,
		size_t *	nLen,
		LPWORD	nNumber )

Parameters

[in]	argCalCode	(Required) the calendar code (e.g. US, NYSE, CBT), name or alias. If missing, the US Government calendar is used.
[out]	retVal	(Required) the buffer that will receive the comma-separated holidays codes
[in,out]	nLen	(Required) The maximum number of characters to copy to the buffer.
[out]	nNumber	(Required) the number of holidays returned.

Returns

status code of the function call: zero = success, positive = success with a warning, and negative = error occurred.

Return values

NDK_SUCCESS	success
NDK_FAILED	error

See also

SFDB_ISWRKDY()

returns the list of holidays codes in a given calendar.

Remarks

Example

Requirements

Target Platform	Windows
Header	SFDBM.h (include Windows.h)
Library	SFDBM.lib
DLL	SFDBM.dll

Since

v1.68

SFDB_CALNAME()

int __stdcall SFDB_CALNAME	(	LPCTSTR	argCode,
		LPTSTR	retVal,
		size_t *	nLen )

Parameters

[in]	argCode	(Required) the calendar short code.
[out]	retVal	(Required) The buffer that will receive the calendar name
[in,out]	nLen	(Required) The maximum number of characters to copy to the buffer.

Returns

status code of the function call: zero = success, positive = success with a warning, and negative = error occurred.

Return values

NDK_SUCCESS	success
NDK_FAILED	error

See also

SFDB_ISWRKDY()

returns the calendar name for given calendar code,

Remarks

Example

Requirements

Target Platform	Windows
Header	SFDBM.h (include Windows.h)
Library	SFDBM.lib
DLL	SFDBM.dll

Since

v1.68

SFDB_CALWKND()

int __stdcall SFDB_CALWKND	(	LPCTSTR	argCalCode,
		LPWORD	nWKNDNo )

Parameters

[in]	argCalCode	(Required) the calendar code (e.g. US, NYSE, CBT), name or alias. If missing, the US Government calendar is used.
[out]	nWKNDNo	(Required) the weekend number (1-7, 11-17).

Returns

status code of the function call: zero = success, positive = success with a warning, and negative = error occurred.

Return values

NDK_SUCCESS	success
NDK_FAILED	error

See also

SFDB_ISWRKDY()

returns the weekend convention code for a given calendar.

Remarks

Example

Requirements

Target Platform	Windows
Header	SFDBM.h (include Windows.h)
Library	SFDBM.lib
DLL	SFDBM.dll

Since

v1.68

SFDB_ISVALIDCALCODE()

int __stdcall SFDB_ISVALIDCALCODE

(

LPCTSTR

argCode

)

Parameters

[in]

argCode

(Required) the given calendar code.

Returns

status code of the function call: NDK_TRUE, NDK_FALSE, and negative = error occurred.

Return values

NDK_TRUE	the given code is a valid/supported calendar code
NDK_FALSE	the given code is not a valid/supported calendar code
NDK_FAILED	Operation was unsuccessful.

See also

SFDB_FindHLDY()

examine the given code whether the given code is a country, currency, built-in, etc, and whetehr we support a holiday calendar.

Remarks

Example

Requirements

Target Platform	Windows
Header	SFDBM.h (include Windows.h)
Library	SFDBM.lib
DLL	SFDBM.dll

Since

v1.68

Parameters

[in]

argCode

is the given calendar code