SHGetLocalizedName
関数パスのローカライズされた表示名を取得する。
シグネチャ
// SHELL32.dll
#include <windows.h>
HRESULT SHGetLocalizedName(
LPCWSTR pszPath,
LPWSTR pszResModule,
DWORD cch,
INT* pidsRes
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCWSTR | in | ファイルの完全修飾パスを指定する文字列へのポインター。 |
| pszResModule | LPWSTR | out | この関数が返るときに、ファイル名のローカライズされたバージョンを指定する文字列リソースへのポインターが格納されます。 |
| cch | DWORD | in | この関数が返るときに、pszResModule にある文字列のサイズが WCHAR 単位で格納されます。 |
| pidsRes | INT* | out | この関数が返るときに、リソースファイル内のローカライズされたファイル名の ID へのポインターが格納されます。 |
戻り値の型: HRESULT
公式ドキュメント
Shell フォルダー内のファイルのローカライズされた名前を取得します。
戻り値
型: HRESULT
この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll
#include <windows.h>
HRESULT SHGetLocalizedName(
LPCWSTR pszPath,
LPWSTR pszResModule,
DWORD cch,
INT* pidsRes
);[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetLocalizedName(
[MarshalAs(UnmanagedType.LPWStr)] string pszPath, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszResModule, // LPWSTR out
uint cch, // DWORD
out int pidsRes // INT* out
);<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetLocalizedName(
<MarshalAs(UnmanagedType.LPWStr)> pszPath As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> pszResModule As System.Text.StringBuilder, ' LPWSTR out
cch As UInteger, ' DWORD
<Out> ByRef pidsRes As Integer ' INT* out
) As Integer
End Function' pszPath : LPCWSTR
' pszResModule : LPWSTR out
' cch : DWORD
' pidsRes : INT* out
Declare PtrSafe Function SHGetLocalizedName Lib "shell32" ( _
ByVal pszPath As LongPtr, _
ByVal pszResModule As LongPtr, _
ByVal cch As Long, _
ByRef pidsRes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHGetLocalizedName = ctypes.windll.shell32.SHGetLocalizedName
SHGetLocalizedName.restype = ctypes.c_int
SHGetLocalizedName.argtypes = [
wintypes.LPCWSTR, # pszPath : LPCWSTR
wintypes.LPWSTR, # pszResModule : LPWSTR out
wintypes.DWORD, # cch : DWORD
ctypes.POINTER(ctypes.c_int), # pidsRes : INT* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHGetLocalizedName = Fiddle::Function.new(
lib['SHGetLocalizedName'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPCWSTR
Fiddle::TYPE_VOIDP, # pszResModule : LPWSTR out
-Fiddle::TYPE_INT, # cch : DWORD
Fiddle::TYPE_VOIDP, # pidsRes : INT* out
],
Fiddle::TYPE_INT)#[link(name = "shell32")]
extern "system" {
fn SHGetLocalizedName(
pszPath: *const u16, // LPCWSTR
pszResModule: *mut u16, // LPWSTR out
cch: u32, // DWORD
pidsRes: *mut i32 // INT* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetLocalizedName([MarshalAs(UnmanagedType.LPWStr)] string pszPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszResModule, uint cch, out int pidsRes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetLocalizedName' -Namespace Win32 -PassThru
# $api::SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes)#uselib "SHELL32.dll"
#func global SHGetLocalizedName "SHGetLocalizedName" sptr, sptr, sptr, sptr
; SHGetLocalizedName pszPath, varptr(pszResModule), cch, varptr(pidsRes) ; 戻り値は stat
; pszPath : LPCWSTR -> "sptr"
; pszResModule : LPWSTR out -> "sptr"
; cch : DWORD -> "sptr"
; pidsRes : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHELL32.dll" #cfunc global SHGetLocalizedName "SHGetLocalizedName" wstr, var, int, var ; res = SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes) ; pszPath : LPCWSTR -> "wstr" ; pszResModule : LPWSTR out -> "var" ; cch : DWORD -> "int" ; pidsRes : INT* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global SHGetLocalizedName "SHGetLocalizedName" wstr, sptr, int, sptr ; res = SHGetLocalizedName(pszPath, varptr(pszResModule), cch, varptr(pidsRes)) ; pszPath : LPCWSTR -> "wstr" ; pszResModule : LPWSTR out -> "sptr" ; cch : DWORD -> "int" ; pidsRes : INT* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT SHGetLocalizedName(LPCWSTR pszPath, LPWSTR pszResModule, DWORD cch, INT* pidsRes) #uselib "SHELL32.dll" #cfunc global SHGetLocalizedName "SHGetLocalizedName" wstr, var, int, var ; res = SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes) ; pszPath : LPCWSTR -> "wstr" ; pszResModule : LPWSTR out -> "var" ; cch : DWORD -> "int" ; pidsRes : INT* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SHGetLocalizedName(LPCWSTR pszPath, LPWSTR pszResModule, DWORD cch, INT* pidsRes) #uselib "SHELL32.dll" #cfunc global SHGetLocalizedName "SHGetLocalizedName" wstr, intptr, int, intptr ; res = SHGetLocalizedName(pszPath, varptr(pszResModule), cch, varptr(pidsRes)) ; pszPath : LPCWSTR -> "wstr" ; pszResModule : LPWSTR out -> "intptr" ; cch : DWORD -> "int" ; pidsRes : INT* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHGetLocalizedName = shell32.NewProc("SHGetLocalizedName")
)
// pszPath (LPCWSTR), pszResModule (LPWSTR out), cch (DWORD), pidsRes (INT* out)
r1, _, err := procSHGetLocalizedName.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
uintptr(pszResModule),
uintptr(cch),
uintptr(pidsRes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SHGetLocalizedName(
pszPath: PWideChar; // LPCWSTR
pszResModule: PWideChar; // LPWSTR out
cch: DWORD; // DWORD
pidsRes: Pointer // INT* out
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetLocalizedName';result := DllCall("SHELL32\SHGetLocalizedName"
, "WStr", pszPath ; LPCWSTR
, "Ptr", pszResModule ; LPWSTR out
, "UInt", cch ; DWORD
, "Ptr", pidsRes ; INT* out
, "Int") ; return: HRESULT●SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes) = DLL("SHELL32.dll", "int SHGetLocalizedName(char*, char*, dword, void*)")
# 呼び出し: SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes)
# pszPath : LPCWSTR -> "char*"
# pszResModule : LPWSTR out -> "char*"
# cch : DWORD -> "dword"
# pidsRes : INT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shell32" fn SHGetLocalizedName(
pszPath: [*c]const u16, // LPCWSTR
pszResModule: [*c]u16, // LPWSTR out
cch: u32, // DWORD
pidsRes: [*c]i32 // INT* out
) callconv(std.os.windows.WINAPI) i32;proc SHGetLocalizedName(
pszPath: WideCString, # LPCWSTR
pszResModule: ptr uint16, # LPWSTR out
cch: uint32, # DWORD
pidsRes: ptr int32 # INT* out
): int32 {.importc: "SHGetLocalizedName", stdcall, dynlib: "SHELL32.dll".}pragma(lib, "shell32");
extern(Windows)
int SHGetLocalizedName(
const(wchar)* pszPath, // LPCWSTR
wchar* pszResModule, // LPWSTR out
uint cch, // DWORD
int* pidsRes // INT* out
);ccall((:SHGetLocalizedName, "SHELL32.dll"), stdcall, Int32,
(Cwstring, Ptr{UInt16}, UInt32, Ptr{Int32}),
pszPath, pszResModule, cch, pidsRes)
# pszPath : LPCWSTR -> Cwstring
# pszResModule : LPWSTR out -> Ptr{UInt16}
# cch : DWORD -> UInt32
# pidsRes : INT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetLocalizedName(
const uint16_t* pszPath,
uint16_t* pszResModule,
uint32_t cch,
int32_t* pidsRes);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes)
-- pszPath : LPCWSTR
-- pszResModule : LPWSTR out
-- cch : DWORD
-- pidsRes : INT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetLocalizedName = lib.func('__stdcall', 'SHGetLocalizedName', 'int32_t', ['str16', 'uint16_t *', 'uint32_t', 'int32_t *']);
// SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes)
// pszPath : LPCWSTR -> 'str16'
// pszResModule : LPWSTR out -> 'uint16_t *'
// cch : DWORD -> 'uint32_t'
// pidsRes : INT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHGetLocalizedName: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes)
// pszPath : LPCWSTR -> "buffer"
// pszResModule : LPWSTR out -> "buffer"
// cch : DWORD -> "u32"
// pidsRes : INT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetLocalizedName(
const uint16_t* pszPath,
uint16_t* pszResModule,
uint32_t cch,
int32_t* pidsRes);
C, "SHELL32.dll");
// $ffi->SHGetLocalizedName(pszPath, pszResModule, cch, pidsRes);
// pszPath : LPCWSTR
// pszResModule : LPWSTR out
// cch : DWORD
// pidsRes : INT* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shell32 extends StdCallLibrary {
Shell32 INSTANCE = Native.load("shell32", Shell32.class);
int SHGetLocalizedName(
WString pszPath, // LPCWSTR
char[] pszResModule, // LPWSTR out
int cch, // DWORD
IntByReference pidsRes // INT* out
);
}@[Link("shell32")]
lib LibSHELL32
fun SHGetLocalizedName = SHGetLocalizedName(
pszPath : UInt16*, # LPCWSTR
pszResModule : UInt16*, # LPWSTR out
cch : UInt32, # DWORD
pidsRes : Int32* # INT* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHGetLocalizedNameNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Int32>);
typedef SHGetLocalizedNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Int32>);
final SHGetLocalizedName = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHGetLocalizedNameNative, SHGetLocalizedNameDart>('SHGetLocalizedName');
// pszPath : LPCWSTR -> Pointer<Utf16>
// pszResModule : LPWSTR out -> Pointer<Utf16>
// cch : DWORD -> Uint32
// pidsRes : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHGetLocalizedName(
pszPath: PWideChar; // LPCWSTR
pszResModule: PWideChar; // LPWSTR out
cch: DWORD; // DWORD
pidsRes: Pointer // INT* out
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetLocalizedName';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHGetLocalizedName"
c_SHGetLocalizedName :: CWString -> CWString -> Word32 -> Ptr Int32 -> IO Int32
-- pszPath : LPCWSTR -> CWString
-- pszResModule : LPWSTR out -> CWString
-- cch : DWORD -> Word32
-- pidsRes : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shgetlocalizedname =
foreign "SHGetLocalizedName"
((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr int32_t) @-> returning int32_t)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* pszResModule : LPWSTR out -> (ptr uint16_t) *)
(* cch : DWORD -> uint32_t *)
(* pidsRes : INT* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHGetLocalizedName" shget-localized-name :convention :stdcall) :int32
(psz-path (:string :encoding :utf-16le)) ; LPCWSTR
(psz-res-module :pointer) ; LPWSTR out
(cch :uint32) ; DWORD
(pids-res :pointer)) ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHGetLocalizedName = Win32::API::More->new('SHELL32',
'int SHGetLocalizedName(LPCWSTR pszPath, LPWSTR pszResModule, DWORD cch, LPVOID pidsRes)');
# my $ret = $SHGetLocalizedName->Call($pszPath, $pszResModule, $cch, $pidsRes);
# pszPath : LPCWSTR -> LPCWSTR
# pszResModule : LPWSTR out -> LPWSTR
# cch : DWORD -> DWORD
# pidsRes : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。