Date and Calendar Analytics
Functions
Currency's Calendar functions
calendar APIs » Calendar functions

A set of functions for exploring currency-based (aka., Bank) calendar for use in calendar and business date calculations. More...

Functions

int __stdcall SFDB_ISVALIDCCYCODE (LPCTSTR argCode)
 Examine whether is the given code is a valid ISO currency code.
 
int __stdcall SFDB_GETWKNDFROMCCY (LPCTSTR argCode, LPTSTR retVal, size_t *nLen)
 return the weekend convention code for the calendar of the given currency.
 
int __stdcall SFDB_GETCALFROMCCY (LPCTSTR argCode, LPTSTR retVal, size_t *nLen)
 Return the calendar code (Bank) the given currency.
 

Detailed Description

The API comes with pre-defined list of calendars adopted by the central bank of different currency.

Function Documentation

◆ SFDB_GETCALFROMCCY()

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

return the calendar code associated with the given currency

Parameters
[in]argCode(Required) the ISO code of the currency (e.g., USD, JPY)
[out]retVal(Optional) the buffer that will receive the calendar code.
[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_SUCCESSsuccess
NDK_INVALID_ARGfailed (see remarks)
NDK_LENGTH_ERRORfailed (see remarks)
NDK_FAILEDfailed
Remarks
  1. The list of calendar definitions can be found here.
  2. If the calendar module has not been initialized, the function will fail and return NDK_FAILED as the return code.
  3. The function is available in the lite (free) version without any restrictions.
  4. If the value of argCode is NULL or empty string, the function will fail and return NDK_INVALID_ARG as error code.
  5. If the value of nLen is NULL, the function will fail and return NDK_INVALID_ARG as error code.
  6. If retVal is NULL, the function returns NDK_SUCCESS and stores the required size of the data, in characters, in the variable pointed to by nLen. This enables an application to determine the best way to allocate a buffer for the value's data.
  7. If the value of the retVal is not NULL, but the buffer size (specififed by *nLen) is smaller than needed, the function will fail and return NDK_LENGTH_ERROR as error code.
Requirements
Requirement Value
Target Platform Windows
Header SFDBM.h (include Windows.h)
Library SFDBM.lib
DLL SFDBM.dll
SFLUC.dll
SFLOG.dll
Since
v1.56
See also

◆ SFDB_GETWKNDFROMCCY()

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

return the weekend code (7 characters) associated with the given currency

Parameters
[in]argCode(Required) the ISO code of the currency (e.g., USD, JPY)
[out]retVal(Optional) the buffer that will receive the weekend code.
[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_SUCCESSsuccess
NDK_INVALID_ARGfailed (see remarks)
NDK_LENGTH_ERRORfailed (see remarks)
NDK_FAILEDfailed
Remarks
  1. The list of calendar definitions can be found here.
  2. If the calendar module has not been initialized, the function will fail and return NDK_FAILED as the return code.
  3. The function is available in the lite (free) version without any restrictions.
  4. If the value of argCode is NULL or empty string, the function will fail and return NDK_INVALID_ARG as error code.
  5. If the value of nLen is NULL, the function will fail and return NDK_INVALID_ARG as error code.
  6. If retVal is NULL, the function returns NDK_SUCCESS and stores the required size of the data, in characters, in the variable pointed to by nLen. This enables an application to determine the best way to allocate a buffer for the value's data.
  7. If the value of the retVal is not NULL, but the buffer size (specififed by *nLen) is smaller than needed, the function will fail and return NDK_LENGTH_ERROR as error code.
Requirements
Requirement Value
Target Platform Windows
Header SFDBM.h (include Windows.h)
Library SFDBM.lib
DLL SFDBM.dll
SFLUC.dll
SFLOG.dll
Since
v1.56
See also

◆ SFDB_ISVALIDCCYCODE()

int __stdcall SFDB_ISVALIDCCYCODE ( LPCTSTR argCode)

examine the validity of the currency iso code

Parameters
[in]argCode(Required) the currency ISO code (e.g. USD, JPY, etc.)
Returns
status code of the function call: NDK_TRUE, NDK_FALSE, and negative = error occurred.
Return values
NDK_TRUEsuccess (TRUE)
NDK_FALSEsuccess (FALSE)
NDK_INVALID_ARGfailed (see remarks)
NDK_INVALID_VALUEfailed (see remarks)
NDK_FAILEDfailed
Remarks
  1. If the calendar module has not been initialized, the function will fail and return NDK_FAILED as the return code.
  2. The function is available in the lite (free) version without any restrictions.
  3. If the value of argCalCode is NULL or empty string, the function will fail and return NDK_INVALID_ARG as error code.
Requirements
Requirement Value
Target Platform Windows
Header SFDBM.h (include Windows.h)
Library SFDBM.lib
DLL SFDBM.dll
SFLUC.dll
SFLOG.dll
Since
v1.56
See also