StormLib API Reference

SFileSetLocale

Description

LCID WINAPI SFileSetLocale(
  LCID lcNewLocale                  // Locale ID for file operations
);

Function SFileSetLocale sets a preferred locale for file functions, such as SFileOpenFileEx or SFileAddFileEx. The locale is stored as a global variable and thus affects every open or add operation.

Note that this function does not change locale ID of any existing file in the MPQ.

Parameters

lcNewLocale

[in] Locale ID to be set.

Return Value

The function never fails and always returns lcNewLocale.

Remarks

The locale ID corresponds to the country ID. Country IDs are defined in Windows headers. The following table shows an example of existing locales:

Different StormLib functions treat the preferred locale differently:

• Read-type functions, such as SFileOpenFileEx, look for the preferred locale version first. If such locale version doesn't exist in the MPQ, the function takes file with neutral locale, if any.
• Write-type functions, such as SFileRenameFile or SFileRemoveFile, only work on preferred locale version. If such locale version doesn't exist in the MPQ, the function fails.
• Add-type functions, such as SFileAddFileEx, only add the preferred locale version of the file to the MPQ. If such file already exists in MPQ, the function either overwrites the old file or fails, depending on parameters.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010