Initialzation and shutdown APIs

API for Initializing, configuring, and shutdown the Date and Calendar analytics API. More...

Functions
int __stdcall	SFDB_Init (LPCWSTR szBaseFileName, LPCWSTR szResDir, DWORD dwLocale, unsigned int *pClientToken)
	initialize the SFDBM Library
int __stdcall	SFDB_Shutdown (unsigned int uClientToken)
	shutdown and release resources used by SFDBM Library

Detailed Description

Function Documentation

SFDB_Init()

int __stdcall SFDB_Init	(	LPCWSTR	szBaseFileName,
		LPCWSTR	szResDir,
		DWORD	dwLocale,
		unsigned int *	pClientToken )

Parameters

[in]	szBaseFileName	(Required) Is the base filename of the database file
[in]	szResDir	(Optional) Is the location of the calendar resources files
[in]	dwLocale	(Required) Is the MS Locality ID
[out]	pClientToken	(Required) is an integer token used during the calendar facility shutdown

Returns

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

Return values

NDK_SUCCESS	success
NDK_SKIP_INIT	success with a warning
NDK_FAILED	error
NDK_DATAPATH_INVALID	error

See also

SFDB_Shutdown

Remarks

Example

Requirements

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

Since

v1.68

SFDB_Shutdown()

int __stdcall SFDB_Shutdown

(

unsigned int

uClientToken

)

Parameters

[in]

uClientToken

(Required) is an integer token acquired during the calendar facility initialization.

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_Init

Shutdown the session (e.g. closes files, terminate database connection, etc.)

Remarks

Example

Requirements

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

Since

v1.68