FX currency pair functions

functions for exploring pre-defined FX currency-pair (combined) calendar for use in calendar and business date calculations. More...

Functions
int __stdcall	SFDB_GETVALIDCCYPAIR (LPCTSTR CCY1, LPCTSTR CCY2, LPTSTR retVal, size_t *nLen)
	Return a currency pair ordered in FX mkt convention.

Detailed Description

The API comes with pre-defined list of calendars adopted by the FX marketplace of different traded currency-pairs.

Function Documentation

SFDB_GETVALIDCCYPAIR()

int __stdcall SFDB_GETVALIDCCYPAIR	(	LPCTSTR	CCY1,
		LPCTSTR	CCY2,
		LPTSTR	retVal,
		size_t *	nLen )

Return a currency pair ordered in FX mkt convention

Parameters

[in]	CCY1	(Required) the ISO code of the first currency (e.g., USD, JPY)
[in]	CCY2	(Required) the ISO code of the second currency (e.g., USD, JPY)
[out]	retVal	(Optional) the buffer that will receive the formatted currency pair.
[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_INVALID_ARG	failed (see remarks)
NDK_LENGTH_ERROR	failed (see remarks)
NDK_FAILED	failed

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 CCY1 or CCY2 is NULL or empty string, the function will fail and return NDK_INVALID_ARG as error code.
5. If the value of CCY1 or CCY2 does not correspond to a valid ISO currency code, the function will fail and return NDK_FAILED as error code.
6. If the value of nLen is NULL, the function will fail and return NDK_INVALID_ARG as error code.
7. 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.
8. 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