SHGetLocalizedName function (shellapi.h)

Retrieves the localized name of a file in a Shell folder.

Syntax

SHSTDAPI SHGetLocalizedName(
  [in]  PCWSTR pszPath,
  [out] PWSTR  pszResModule,
        UINT   cch,
  [out] int    *pidsRes
);

Parameters

[in] pszPath

Type: PCWSTR

A pointer to a string that specifies the fully qualified path of the file.

[out] pszResModule

Type: PWSTR

When this function returns, contains a pointer to a string resource that specifies the localized version of the file name.

cch

Type: UINT

When this function returns, contains the size of the string, in WCHARs, at pszResModule.

[out] pidsRes

Type: int*

When this function returns, contains a pointer to the ID of the localized file name in the resource file.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shellapi.h
DLL Shell32.dll