ILIsParent

関数

あるPIDLが別のPIDLの親であるかを判定する。

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

シグネチャ

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

BOOL ILIsParent(
    ITEMIDLIST* pidl1,
    ITEMIDLIST* pidl2,
    BOOL fImmediate
);

パラメーター

名前	型	方向	説明
pidl1	ITEMIDLIST*	in	親を指定する ITEMIDLIST (PIDL) 構造体へのポインターです。これは絶対 PIDL でなければなりません。
pidl2	ITEMIDLIST*	in	子を指定する ITEMIDLIST (PIDL) 構造体へのポインターです。これは絶対 PIDL でなければなりません。
fImmediate	BOOL	in	pidl2 の直接の親をテストする場合は TRUE に、pidl2 の任意の親をテストする場合は FALSE に設定するブール値です。

戻り値の型: BOOL

公式ドキュメント

ある ITEMIDLIST 構造体が別の ITEMIDLIST 構造体の親であるかどうかをテストします。

戻り値

型: BOOL

pidl1 が pidl2 の親である場合は TRUE を返します。fImmediate が TRUE に設定されている場合、この関数は pidl1 が pidl2 の直接の親である場合にのみ TRUE を返します。それ以外の場合、この関数は FALSE を返します。

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

各言語での呼び出し定義

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

BOOL ILIsParent(
    ITEMIDLIST* pidl1,
    ITEMIDLIST* pidl2,
    BOOL fImmediate
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool ILIsParent(
    IntPtr pidl1,   // ITEMIDLIST*
    IntPtr pidl2,   // ITEMIDLIST*
    bool fImmediate   // BOOL
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function ILIsParent(
    pidl1 As IntPtr,   ' ITEMIDLIST*
    pidl2 As IntPtr,   ' ITEMIDLIST*
    fImmediate As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pidl1 : ITEMIDLIST*
' pidl2 : ITEMIDLIST*
' fImmediate : BOOL
Declare PtrSafe Function ILIsParent Lib "shell32" ( _
    ByVal pidl1 As LongPtr, _
    ByVal pidl2 As LongPtr, _
    ByVal fImmediate As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ILIsParent = ctypes.windll.shell32.ILIsParent
ILIsParent.restype = wintypes.BOOL
ILIsParent.argtypes = [
    ctypes.c_void_p,  # pidl1 : ITEMIDLIST*
    ctypes.c_void_p,  # pidl2 : ITEMIDLIST*
    wintypes.BOOL,  # fImmediate : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ILIsParent = Fiddle::Function.new(
  lib['ILIsParent'],
  [
    Fiddle::TYPE_VOIDP,  # pidl1 : ITEMIDLIST*
    Fiddle::TYPE_VOIDP,  # pidl2 : ITEMIDLIST*
    Fiddle::TYPE_INT,  # fImmediate : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn ILIsParent(
        pidl1: *mut ITEMIDLIST,  // ITEMIDLIST*
        pidl2: *mut ITEMIDLIST,  // ITEMIDLIST*
        fImmediate: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool ILIsParent(IntPtr pidl1, IntPtr pidl2, bool fImmediate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ILIsParent' -Namespace Win32 -PassThru
# $api::ILIsParent(pidl1, pidl2, fImmediate)

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

出力引数:

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