ILAppendID

関数

PIDLの末尾または先頭にアイテムIDを追加する。

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

シグネチャ

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

ITEMIDLIST* ILAppendID(
    ITEMIDLIST* pidl,   // optional
    SHITEMID* pmkid,
    BOOL fAppend
);

パラメーター

名前	型	方向	説明
pidl	ITEMIDLIST*	inoptional	ITEMIDLIST 構造体へのポインターです。関数が返るとき、pmkid で指定された SHITEMID 構造体が末尾または先頭に追加されています。
pmkid	SHITEMID*	in	pidl の末尾または先頭に追加する SHITEMID 構造体へのポインターです。
fAppend	BOOL	in	pmkid を pidl の末尾に追加する場合は TRUE を設定する値です。先頭に追加する場合は FALSE を設定します。

戻り値の型: ITEMIDLIST*

公式ドキュメント

SHITEMID 構造体を ITEMIDLIST 構造体の末尾または先頭に追加します。

戻り値

型: PIDLIST_RELATIVE

pmkid が末尾または先頭に追加された、pidl で指定された ITEMIDLIST 構造体を返します。失敗した場合は NULL を返します。

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

各言語での呼び出し定義

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

ITEMIDLIST* ILAppendID(
    ITEMIDLIST* pidl,   // optional
    SHITEMID* pmkid,
    BOOL fAppend
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern IntPtr ILAppendID(
    IntPtr pidl,   // ITEMIDLIST* optional
    IntPtr pmkid,   // SHITEMID*
    bool fAppend   // BOOL
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function ILAppendID(
    pidl As IntPtr,   ' ITEMIDLIST* optional
    pmkid As IntPtr,   ' SHITEMID*
    fAppend As Boolean   ' BOOL
) As IntPtr
End Function

' pidl : ITEMIDLIST* optional
' pmkid : SHITEMID*
' fAppend : BOOL
Declare PtrSafe Function ILAppendID Lib "shell32" ( _
    ByVal pidl As LongPtr, _
    ByVal pmkid As LongPtr, _
    ByVal fAppend As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ILAppendID = ctypes.windll.shell32.ILAppendID
ILAppendID.restype = ctypes.c_void_p
ILAppendID.argtypes = [
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    ctypes.c_void_p,  # pmkid : SHITEMID*
    wintypes.BOOL,  # fAppend : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ILAppendID = Fiddle::Function.new(
  lib['ILAppendID'],
  [
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # pmkid : SHITEMID*
    Fiddle::TYPE_INT,  # fAppend : BOOL
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shell32")]
extern "system" {
    fn ILAppendID(
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        pmkid: *mut SHITEMID,  // SHITEMID*
        fAppend: i32  // BOOL
    ) -> *mut ITEMIDLIST;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern IntPtr ILAppendID(IntPtr pidl, IntPtr pmkid, bool fAppend);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ILAppendID' -Namespace Win32 -PassThru
# $api::ILAppendID(pidl, pmkid, fAppend)

#uselib "SHELL32.dll"
#func global ILAppendID "ILAppendID" sptr, sptr, sptr
; ILAppendID varptr(pidl), varptr(pmkid), fAppend   ; 戻り値は stat
; pidl : ITEMIDLIST* optional -> "sptr"
; pmkid : SHITEMID* -> "sptr"
; fAppend : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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