StormLib API Reference

SFileEnumLocales

Description

int WINAPI SFileEnumLocales(
  HANDLE hMpq,                      // MPQ handle
  const char * szFileName,          // Name of the file to enum
  LCID * plcLocales,                // Array of file locales
  DWORD * pdwMaxLocales,            // Maximum number of locales
  DWORD dwSearchScope               // Ignored
);

Function SFileEnumLocales enumerates all locales for the given file that are present in the MPQ.

Parameters

hMpq

[in] Handle to a MPQ.

szFileName

[in] Name of a file to enumerate the locales.

plcLocales

[out] An array of LCIDs that will receive locales. This parameter can be NULL if pdwMaxLocales points to zero.

pdwMaxLocales

[in, out] On input, this argument must point to a variable that contains maximum number of entries in plcLocales array. On output, this variable receives number of locales that are for the file. This argument cannot be NULL.

dwSearchScope

[in] This parameter is ignored.

Return Value

When the function succeeds, it returns ERROR_SUCCESS. On an error, the function returns an error code.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010