ホーム › UI.Shell › SHGetNameFromIDList

SHGetNameFromIDList

関数

アイテムIDリストから指定形式の表示名を取得する。

DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

HRESULT SHGetNameFromIDList(
    ITEMIDLIST* pidl,
    SIGDN sigdnName,
    LPWSTR* ppszName
);

パラメーター

名前	型	方向	説明
pidl	ITEMIDLIST*	in	項目を識別する PIDL です。
sigdnName	SIGDN	in	取得する表示名の種類を指定する SIGDN 列挙体の値です。
ppszName	LPWSTR*	out	この関数が正常に終了したときに、取得した表示名へのポインターのアドレスを受け取る値です。

戻り値の型: HRESULT

公式ドキュメント

IDList で識別される項目の表示名を取得します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ppszName が指す文字列が不要になったときに解放するのは、呼び出し側の責任です。*ppszName に対して CoTaskMemFree を呼び出してメモリを解放してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

HRESULT SHGetNameFromIDList(
    ITEMIDLIST* pidl,
    SIGDN sigdnName,
    LPWSTR* ppszName
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetNameFromIDList(
    IntPtr pidl,   // ITEMIDLIST*
    int sigdnName,   // SIGDN
    IntPtr ppszName   // LPWSTR* out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetNameFromIDList(
    pidl As IntPtr,   ' ITEMIDLIST*
    sigdnName As Integer,   ' SIGDN
    ppszName As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pidl : ITEMIDLIST*
' sigdnName : SIGDN
' ppszName : LPWSTR* out
Declare PtrSafe Function SHGetNameFromIDList Lib "shell32" ( _
    ByVal pidl As LongPtr, _
    ByVal sigdnName As Long, _
    ByVal ppszName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetNameFromIDList = ctypes.windll.shell32.SHGetNameFromIDList
SHGetNameFromIDList.restype = ctypes.c_int
SHGetNameFromIDList.argtypes = [
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    ctypes.c_int,  # sigdnName : SIGDN
    ctypes.c_void_p,  # ppszName : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetNameFromIDList = Fiddle::Function.new(
  lib['SHGetNameFromIDList'],
  [
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST*
    Fiddle::TYPE_INT,  # sigdnName : SIGDN
    Fiddle::TYPE_VOIDP,  # ppszName : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetNameFromIDList(
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST*
        sigdnName: i32,  // SIGDN
        ppszName: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetNameFromIDList(IntPtr pidl, int sigdnName, IntPtr ppszName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetNameFromIDList' -Namespace Win32 -PassThru
# $api::SHGetNameFromIDList(pidl, sigdnName, ppszName)

#uselib "SHELL32.dll"
#func global SHGetNameFromIDList "SHGetNameFromIDList" sptr, sptr, sptr
; SHGetNameFromIDList varptr(pidl), sigdnName, varptr(ppszName)   ; 戻り値は stat
; pidl : ITEMIDLIST* -> "sptr"
; sigdnName : SIGDN -> "sptr"
; ppszName : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetNameFromIDList "SHGetNameFromIDList" var, int, var
; res = SHGetNameFromIDList(pidl, sigdnName, ppszName)
; pidl : ITEMIDLIST* -> "var"
; sigdnName : SIGDN -> "int"
; ppszName : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetNameFromIDList "SHGetNameFromIDList" sptr, int, sptr
; res = SHGetNameFromIDList(varptr(pidl), sigdnName, varptr(ppszName))
; pidl : ITEMIDLIST* -> "sptr"
; sigdnName : SIGDN -> "int"
; ppszName : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。