Localization functions

This category contains functions for getting information about current locale. More...

Enumerations

Type	Name
enum	fplLocaleFormat { fplLocaleFormat_None , fplLocaleFormat_ISO639 } An enumeration of locale formats. More...

Functions

Type	Name
fpl_platform_api size_t	fplGetInputLocale (const fplLocaleFormat targetFormat, char *buffer, const size_t maxBufferLen) Gets the input locale in the given target format.
fpl_platform_api size_t	fplGetSystemLocale (const fplLocaleFormat targetFormat, char *buffer, const size_t maxBufferLen) Gets the system locale in the given target format.
fpl_platform_api size_t	fplGetUserLocale (const fplLocaleFormat targetFormat, char *buffer, const size_t maxBufferLen) Gets the user locale in the given target format.

Detailed Description

This category contains functions for getting information about current locale.

Enumeration Type Documentation

fplLocaleFormat

enum fplLocaleFormat

An enumeration of locale formats.

Name	Description
fplLocaleFormat_None	No locale format.
fplLocaleFormat_ISO639	ISO-639 format (de-DE, en-US, etc.).

Definition at line 10708 of file final_platform_layer.h.

Function Documentation

fplGetInputLocale()

fpl_platform_api size_t fplGetInputLocale ( const fplLocaleFormat targetFormat, char * buffer, const size_t maxBufferLen )

Gets the input locale in the given target format.

Parameters

Direction	Parameter	Description
[in]	targetFormat	Target locale format value fplLocaleFormat.
[out]	buffer	Reference to the target string buffer for writing the locale into.
[in]	maxBufferLen	The maximum length of the buffer.

Returns: The number of required/written characters, excluding the null-terminator.

fplGetSystemLocale()

fpl_platform_api size_t fplGetSystemLocale ( const fplLocaleFormat targetFormat, char * buffer, const size_t maxBufferLen )

Gets the system locale in the given target format.

Parameters

Direction	Parameter	Description
[in]	targetFormat	Target locale format value fplLocaleFormat.
[out]	buffer	Reference to the target string buffer for writing the locale into.
[in]	maxBufferLen	The maximum length of the buffer.

Returns: The number of required/written characters, excluding the null-terminator.

fplGetUserLocale()

fpl_platform_api size_t fplGetUserLocale ( const fplLocaleFormat targetFormat, char * buffer, const size_t maxBufferLen )

Gets the user locale in the given target format.

Parameters

Direction	Parameter	Description
[in]	targetFormat	Target locale format value fplLocaleFormat.
[out]	buffer	Reference to the target string buffer for writing the locale into.
[in]	maxBufferLen	The maximum length of the buffer.

Returns: The number of required/written characters, excluding the null-terminator.