ITEMIDLIST

構造体

サイズx64: 3 バイト / x86: 3 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
mkid	SHITEMID	3	+0	+0	項目識別子のリストです。

公式ドキュメント

項目識別子のリストを格納します。

解説(Remarks)

この構造体へのポインターは PIDL と呼ばれ、シェル名前空間内のオブジェクトを識別するために使用されます。項目識別子リストへのポインター (PIDL) および項目識別子の詳細については、Introduction to the Shell Namespace を参照してください。

ITEMIDLIST の厳密な型

Windows Vista 以降、ITEMIDLIST のいくつかの形式がデータ型として利用できます。主な型は次の 3 つです。

IDLIST_ABSOLUTE: 名前空間のルートを基準とする完全修飾の ITEMIDLIST です。複数レベルになる場合があります。
IDLIST_RELATIVE: 親フォルダーを基準とする ITEMIDLIST です。複数レベルになる場合があります。
ITEMID_CHILD: 親フォルダーを基準とする単一レベルの ITEMIDLIST です。SHITEMID 構造体をちょうど 1 つ含みます。

これらの型は、次のコード例のように、シェルのヘッダーファイルをインクルードする前にシンボル STRICT_TYPED_ITEMIDS を定義してコードをコンパイルする場合に使用されます。


#define STRICT_TYPED_ITEMIDS    // IDList の型安全性を高めます

#include <shlobj.h>             // 一般的なシェルのヘッダーファイル

これらの各型の意味は、次の修飾子を 1 つ以上使用して変更できます。

P: 型がポインターであることを示します。
C: 型が定数であることを示します。
U: 型がアラインされていないことを示します。32 ビットアーキテクチャでは DWORD 境界に、64 ビットアーキテクチャでは QWORD 境界にアラインされます。

これらの修飾された型の例をいくつか示します。

PIDLIST_ABSOLUTE: ITEMIDLIST は絶対であり、定数ではないことが示すとおり割り当て済みです。つまり、不要になった時点で ILFree によって解放する必要があります。割り当てられたメモリへの直接のポインターであるため、アラインされています。
PCIDLIST_ABSOLUTE: ITEMIDLIST は絶対かつ定数です。これは通常、絶対 ITEMIDLIST がパラメーターとして渡されたものの、それを所有しておらず変更が許可されていない場合に使用されます。
PCUIDLIST_ABSOLUTE: ITEMIDLIST は絶対、定数、かつアラインされていません。これが使用されることはまれです。絶対 ITEMIDLIST は通常、32 ビットアーキテクチャでは DWORD 境界に、64 ビットアーキテクチャでは QWORD 境界にアラインされたメモリに割り当てられます。絶対 ITEMIDLIST がアラインされていないのは、シリアル化形式などで他のデータと共にバイト単位でパックされている場合だけです。
PITEMID_CHILD: ITEMIDLIST は、IEnumIDList::Next の結果のような、親フォルダーを基準とする割り当て済みの子 ITEMIDLIST です。SHITEMID 構造体をちょうど 1 つ含みます。
PCUITEMID_CHILD: 子 ITEMIDLIST は相対、定数、かつアラインされていません。これは、既存の PIDL の一部へのポインターを取得した場合によく発生します。たとえば、絶対 PIDL に対して ILFindLastID を呼び出すと、リスト内の最後の子 SHITEMID へのポインターが返されます。バイト単位でパックされた PIDL では個々の SHITEMID 構造体がバイト境界に収まることが保証されないため、アラインされていません。このような子 PIDL への参照は、メモリを絶対 PIDL が所有しているため常に定数です。
PCITEMID_CHILD: 子 ITEMIDLIST は定数かつアラインされています。子 PIDL は通常、より大きな PIDL の一部であってバイト境界にアラインされていないため、これが使用されることはまれです。
PUITEMID_CHILD: 子 ITEMIDLIST はアラインされていません。この ITEMIDLIST のメモリは絶対である親 PIDL が所有しているため、これが使用されることはまれです。つまり、変更を加えられるのは親 PIDL に対してのみであり、子 PIDL は定数である必要があります。

このリストはすべてを網羅したものではありません。他の型も存在する可能性があります。

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

各言語での定義

#include <windows.h>

// SHITEMID  (x64 3 / x86 3 バイト)
#pragma pack(push, 1)
typedef struct SHITEMID {
    WORD cb;
    BYTE abID[1];
} SHITEMID;
#pragma pack(pop)

// ITEMIDLIST  (x64 3 / x86 3 バイト)
#pragma pack(push, 1)
typedef struct ITEMIDLIST {
    SHITEMID mkid;
} ITEMIDLIST;
#pragma pack(pop)

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SHITEMID
{
    public ushort cb;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public byte[] abID;
}

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct ITEMIDLIST
{
    public SHITEMID mkid;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SHITEMID
    Public cb As UShort
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public abID() As Byte
End Structure

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure ITEMIDLIST
    Public mkid As SHITEMID
End Structure

import ctypes
from ctypes import wintypes

class SHITEMID(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("cb", ctypes.c_ushort),
        ("abID", ctypes.c_ubyte * 1),
    ]

class ITEMIDLIST(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("mkid", SHITEMID),
    ]

#[repr(C, packed(1))]
pub struct SHITEMID {
    pub cb: u16,
    pub abID: [u8; 1],
}

#[repr(C, packed(1))]
pub struct ITEMIDLIST {
    pub mkid: SHITEMID,
}

import "golang.org/x/sys/windows"

type SHITEMID struct {
	cb uint16
	abID [1]byte
}

type ITEMIDLIST struct {
	mkid SHITEMID
}

type
  SHITEMID = packed record
    cb: Word;
    abID: array[0..0] of Byte;
  end;

  ITEMIDLIST = packed record
    mkid: SHITEMID;
  end;

const SHITEMID = extern struct {
    cb: u16,
    abID: [1]u8,
};

const ITEMIDLIST = extern struct {
    mkid: SHITEMID,
};

type
  SHITEMID {.packed.} = object
    cb: uint16
    abID: array[1, uint8]

  ITEMIDLIST {.packed.} = object
    mkid: SHITEMID

align(1)
struct SHITEMID
{
    ushort cb;
    ubyte[1] abID;
}

align(1)
struct ITEMIDLIST
{
    SHITEMID mkid;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ITEMIDLIST サイズ: 3 バイト(x64)
dim st, 1    ; 4byte整数×1(構造体サイズ 3 / 4 切り上げ)
; mkid : SHITEMID (+0, 3byte)  varptr(st)+0 を基点に操作(3byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SHITEMID, pack=1
    #field short cb
    #field byte abID 1
#endstruct

#defstruct global ITEMIDLIST, pack=1
    #field SHITEMID mkid
#endstruct

stdim st, ITEMIDLIST        ; NSTRUCT 変数を確保