SFMSG initialization , shutdown and configuration APIs. More...

Functions
int __stdcall	SFMSG_Reset (unsigned int uClientToken, DWORD lcid)
	Switch the language library to a different one.

int __stdcall	SFMSG_LCID (LPDWORD plcid)
	query the current LCID

int __stdcall	SFMSG_LCID_SUPPORTED (DWORD lcid, LPBOOL pbExist)
	examine whether the given LCID is installed

int __stdcall	SFMSG_NEUTRAL_LCID (LPDWORD pSupportedLCID)
	convert the given LCID to neutral LCID (no sub-language or sort order)

int __stdcall	SFMSG_LCID_PATH (DWORD lcid, LPWSTR szPath, size_t *pSize)
	Return the full path of the locale resources folder on user's filesystem.

Initialzation/Shutdown APIs
int __stdcall	SFMSG_Init (LPCWSTR szDllName, LPCWSTR szResDir, DWORD lcid, unsigned int *pClientToken)
	initialize the SFMSG Library

int __stdcall	SFMSG_Shutdown (unsigned int uClientToken)
	Cleanup the SFMSG Library.

Detailed Description

The functions here setup the locality library to locate the proper resources.

Function Documentation

◆ SFMSG_Init()

int __stdcall SFMSG_Init	(	LPCWSTR	szDllName,
		LPCWSTR	szResDir,
		DWORD	lcid,
		unsigned int *	pClientToken )

Parameters

[in]	szDllName	(Required) is the application name (e.g. NumXL)
[in]	szResDir	(Required) is he location of the resources dll
[in]	lcid	(Required) is MS Locality ID
[out]	pClientToken	(Required) is an integer token used during the locality system 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_FAILED	unknown error

Initialize the locality system.

Note

Remarks

Requirements


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

See also: SFMSG_Shutdown()

◆ SFMSG_LCID()

int __stdcall SFMSG_LCID ( LPDWORD plcid )

Parameters

[out] plcid (Required) is MS Locality ID.

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	unknown error

returns the LCID of the currently selected language.

Note

Remarks

Requirements


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

See also: SFMSG_Init

◆ SFMSG_LCID_PATH()

int __stdcall SFMSG_LCID_PATH	(	DWORD	lcid,
		LPWSTR	szPath,
		size_t *	pSize )

Parameters

[in]	lcid	(Required) is MS Locality ID
[out]	szPath	(Optional) is address to a buffer to hold the path.
[in,out]	pSize	(Required) is the size of the `szPath`, and upon return, holds the number of actual size of the path.

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	unknown error

Lookup and retrieve a the filepath used in our locality system

Note

Remarks

Requirements


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

See also: SFMSG_Init

◆ SFMSG_LCID_SUPPORTED()

int __stdcall SFMSG_LCID_SUPPORTED	(	DWORD	lcid,
		LPBOOL	pbExist )

Parameters

[in]	lcid	(Required) is MS Locality ID
[out]	pbExist	(Required) is a pointer to a BOOLEAN flag to return the status of locality presence in the locality folder.

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	unknown error

Examine the installation directory for the support of the LCID (or it neutral version)

Note

Remarks

Requirements


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

See also: SFMSG_Init

◆ SFMSG_NEUTRAL_LCID()

int __stdcall SFMSG_NEUTRAL_LCID ( LPDWORD pSupportedLCID )

Parameters

[in,out] pSupportedLCID (Required) is a pointer to a LCID holding the input and the return value.

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	unknown error

convert from language+culture LCID to language culture-neutral LCID

Note

Remarks

Requirements


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

See also: SFMSG_Init

◆ SFMSG_Reset()

int __stdcall SFMSG_Reset	(	unsigned int	uClientToken,
		DWORD	lcid )

Parameters

[in]	uClientToken	(Required) Is the locality system token id (acquired during initialization).
[in]	lcid	(Required) is the new MS Locality ID

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	unknown error

Reset the locality language, and free resources.

Note

Remarks

Requirements


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

See also: SFMSG_Init

◆ SFMSG_Shutdown()

int __stdcall SFMSG_Shutdown ( unsigned int uClientToken )

Parameters

[in] uClientToken (Required) Is the locality system token id (acquired during 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	unknown error

shutdown the locality system, and free resources.

Note

Remarks

Requirements


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

See also: SFMSG_Init

Functions

Initialzation/Shutdown APIs

Detailed Description

Function Documentation

◆ SFMSG_Init()

◆ SFMSG_LCID()

◆ SFMSG_LCID_PATH()

◆ SFMSG_LCID_SUPPORTED()

◆ SFMSG_NEUTRAL_LCID()

◆ SFMSG_Reset()

◆ SFMSG_Shutdown()