Win32 API 日本語リファレンス
ホームUI.Shell › SHSimpleIDListFromPath

SHSimpleIDListFromPath

関数
ファイルパスから単純なアイテムIDリストを生成する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

ITEMIDLIST* SHSimpleIDListFromPath(
    LPCWSTR pszPath
);

パラメーター

名前方向説明
pszPathLPCWSTRinPIDL に変換するパスを格納した null 終端文字列へのポインター。

戻り値の型: ITEMIDLIST*

公式ドキュメント

非推奨。パスを渡すと ITEMIDLIST 構造体へのポインターを返します。

戻り値

型: PIDLIST_ABSOLUTE

成功した場合は ITEMIDLIST 構造体へのポインターを返し、それ以外の場合は NULL を返します。

解説(Remarks)

Windows 7 より前では、この関数は Shlobj.h で宣言されていました。Windows 7 以降のバージョンでは、Shobjidl.h で宣言されています。

注意 この関数は Windows 7 および Windows Server 2003 まで利用可能です。将来のバージョンの Windows では存在しなくなる可能性があります。
この関数の代替手段は次のとおりです。
  1. SHGetDesktopFolder を呼び出して、デスクトップフォルダーの IShellFolder を取得します。
  2. IShellFolder のバインドコンテキスト (IBindCtx) を取得します。
  3. IBindCtx とパスを指定して IShellFolder::ParseDisplayName を呼び出します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

ITEMIDLIST* SHSimpleIDListFromPath(
    LPCWSTR pszPath
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern IntPtr SHSimpleIDListFromPath(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHSimpleIDListFromPath(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As IntPtr
End Function
' pszPath : LPCWSTR
Declare PtrSafe Function SHSimpleIDListFromPath Lib "shell32" ( _
    ByVal pszPath As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHSimpleIDListFromPath = ctypes.windll.shell32.SHSimpleIDListFromPath
SHSimpleIDListFromPath.restype = ctypes.c_void_p
SHSimpleIDListFromPath.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHSimpleIDListFromPath = Fiddle::Function.new(
  lib['SHSimpleIDListFromPath'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "shell32")]
extern "system" {
    fn SHSimpleIDListFromPath(
        pszPath: *const u16  // LPCWSTR
    ) -> *mut ITEMIDLIST;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern IntPtr SHSimpleIDListFromPath([MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHSimpleIDListFromPath' -Namespace Win32 -PassThru
# $api::SHSimpleIDListFromPath(pszPath)
#uselib "SHELL32.dll"
#func global SHSimpleIDListFromPath "SHSimpleIDListFromPath" sptr
; SHSimpleIDListFromPath pszPath   ; 戻り値は stat
; pszPath : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHSimpleIDListFromPath "SHSimpleIDListFromPath" wstr
; res = SHSimpleIDListFromPath(pszPath)
; pszPath : LPCWSTR -> "wstr"
; ITEMIDLIST* SHSimpleIDListFromPath(LPCWSTR pszPath)
#uselib "SHELL32.dll"
#cfunc global SHSimpleIDListFromPath "SHSimpleIDListFromPath" wstr
; res = SHSimpleIDListFromPath(pszPath)
; pszPath : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHSimpleIDListFromPath = shell32.NewProc("SHSimpleIDListFromPath")
)

// pszPath (LPCWSTR)
r1, _, err := procSHSimpleIDListFromPath.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // ITEMIDLIST*
function SHSimpleIDListFromPath(
  pszPath: PWideChar   // LPCWSTR
): Pointer; stdcall;
  external 'SHELL32.dll' name 'SHSimpleIDListFromPath';
result := DllCall("SHELL32\SHSimpleIDListFromPath"
    , "WStr", pszPath   ; LPCWSTR
    , "Ptr")   ; return: ITEMIDLIST*
●SHSimpleIDListFromPath(pszPath) = DLL("SHELL32.dll", "void* SHSimpleIDListFromPath(char*)")
# 呼び出し: SHSimpleIDListFromPath(pszPath)
# pszPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHSimpleIDListFromPath(
    pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) [*c]ITEMIDLIST;
proc SHSimpleIDListFromPath(
    pszPath: WideCString  # LPCWSTR
): ptr ITEMIDLIST {.importc: "SHSimpleIDListFromPath", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
ITEMIDLIST* SHSimpleIDListFromPath(
    const(wchar)* pszPath   // LPCWSTR
);
ccall((:SHSimpleIDListFromPath, "SHELL32.dll"), stdcall, Ptr{ITEMIDLIST},
      (Cwstring,),
      pszPath)
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* SHSimpleIDListFromPath(
    const uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHSimpleIDListFromPath(pszPath)
-- pszPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHSimpleIDListFromPath = lib.func('__stdcall', 'SHSimpleIDListFromPath', 'void *', ['str16']);
// SHSimpleIDListFromPath(pszPath)
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHSimpleIDListFromPath: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.SHSimpleIDListFromPath(pszPath)
// pszPath : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* SHSimpleIDListFromPath(
    const uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->SHSimpleIDListFromPath(pszPath);
// pszPath : LPCWSTR
// 構造体/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);
    Pointer SHSimpleIDListFromPath(
        WString pszPath   // LPCWSTR
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHSimpleIDListFromPath = SHSimpleIDListFromPath(
    pszPath : UInt16*   # LPCWSTR
  ) : ITEMIDLIST*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHSimpleIDListFromPathNative = Pointer<Void> Function(Pointer<Utf16>);
typedef SHSimpleIDListFromPathDart = Pointer<Void> Function(Pointer<Utf16>);
final SHSimpleIDListFromPath = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHSimpleIDListFromPathNative, SHSimpleIDListFromPathDart>('SHSimpleIDListFromPath');
// pszPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHSimpleIDListFromPath(
  pszPath: PWideChar   // LPCWSTR
): Pointer; stdcall;
  external 'SHELL32.dll' name 'SHSimpleIDListFromPath';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHSimpleIDListFromPath"
  c_SHSimpleIDListFromPath :: CWString -> IO (Ptr ())
-- pszPath : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shsimpleidlistfrompath =
  foreign "SHSimpleIDListFromPath"
    ((ptr uint16_t) @-> returning (ptr void))
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHSimpleIDListFromPath" shsimple-idlist-from-path :convention :stdcall) :pointer
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHSimpleIDListFromPath = Win32::API::More->new('SHELL32',
    'LPVOID SHSimpleIDListFromPath(LPCWSTR pszPath)');
# my $ret = $SHSimpleIDListFromPath->Call($pszPath);
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型