Final Platform Layer  0.9.6-beta
Typedefs | Enumerations | Functions
Localization functions

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

Typedefs

typedef enum fplLocaleFormat fplLocaleFormat
 A enumeration of locale formats.
 

Enumerations

enum  fplLocaleFormat { fplLocaleFormat_None, fplLocaleFormat_ISO639 }
 A enumeration of locale formats. More...
 

Functions

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

Detailed Description

This category contains functions for getting informations about current locale.

Enumeration Type Documentation

◆ fplLocaleFormat

A enumeration of locale formats.

Enumerator
fplLocaleFormat_None 

No locale format.

fplLocaleFormat_ISO639 

ISO-639 format (de-DE, en-US, etc.)

Definition at line 6780 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
targetFormatTarget fplLocaleFormat
bufferTarget string buffer for writing the locale into
maxBufferLenThe maximum length of the buffer
Returns
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
targetFormatTarget fplLocaleFormat
bufferTarget string buffer for writing the locale into
maxBufferLenThe maximum length of the buffer
Returns
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
targetFormatTarget fplLocaleFormat
bufferTarget string buffer for writing the locale into
maxBufferLenThe maximum length of the buffer
Returns
Returns the number of required/written characters, excluding the null-terminator