Win32 API 日本語リファレンス
ホーム › System.Mmc › SCOPEDATAITEM

SCOPEDATAITEM

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 56 バイト / x86: 36 バイト

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

フィールド

フィールド型サイズx64x86説明
maskDWORD4+0+0

構造体のどのメンバーが有効なデータを含んでいるかを示すフラグの配列を指定する値です。この構造体を IConsoleNameSpace2::GetItem メソッドで使用する場合は、取得する項目の属性を示します。このメンバーには次のいずれかの値を指定できます。

SDI_STR (0x00002)

構造体の displayname メンバーが有効です。SDI_STR は、displayname メンバーに値を指定する場合にのみサポートされます。MMC は displayname メンバーの値を保存しないため、IConsoleNamespace2::GetItem メソッドを呼び出して取得することはできません。

SDI_IMAGE (0x00004)

構造体の nImage メンバーが有効であるか、値を設定する必要があります。

SDI_OPENIMAGE (0x00008)

構造体の nOpenImage メンバーが有効であるか、値を設定する必要があります。

SDI_STATE (0x00010)

構造体の nState メンバーが有効であるか、値を設定する必要があります。

SDI_PARAM (0x00020)

構造体の lParam メンバーが有効であるか、値を設定する必要があります。

SDI_CHILDREN (0x00040)

構造体の cChildren メンバーが有効であるか、値を設定する必要があります。

SDI_PARENT (0x00000000)

スコープ ペインに項目を挿入する場合にのみ使用します。構造体の relativeID メンバーは、親の HSCOPEITEM です。項目は、relativeID が参照する項目の最後の子として挿入されます。

SDI_PREVIOUS (0x10000000)

スコープ ペインに項目を挿入する場合にのみ使用します。構造体の relativeID メンバーは、前の兄弟の HSCOPEITEM です。

SDI_NEXT (0x20000000)

スコープ ペインに項目を挿入する場合にのみ使用します。構造体の relativeID メンバーは、次の兄弟の HSCOPEITEM です。

SDI_FIRST (0x08000000)

スコープ ペインに項目を挿入する場合にのみ使用します。構造体の relativeID メンバーは、親の HSCOPEITEM です。項目は、relativeID が参照する項目の最初の子として挿入されます。

displaynameLPWSTR8/4+8+4

MMC_CALLBACK 値、または null で終わる文字列へのポインターです。どちらになるかは、この構造体の使用方法によって決まります。

  • IConsoleNameSpace2::InsertItem を使用して項目を挿入する場合、このメンバーは MMC_CALLBACK に設定しなければなりません。
  • スナップインが挿入した項目の名前を IConsoleNameSpace2::SetItem を使用して変更する場合、このメンバーは MMC_CALLBACK に設定しなければなりません。
  • 静的ノード (コンソールが挿入する項目) の名前を変更する場合、このメンバーには MMC_CALLBACK を設定するか、項目のテキストを格納した null で終わる文字列へのポインターを設定できます。
スナップインは MMC_CALLBACK の代わりに MMC_TEXTCALLBACK を使用できることに注意してください。MMC_TEXTCALLBACK の値は、MMC_CALLBACK の型が正しい (キャストが不要な) バージョンです。

MMC_TEXTCALLBACK は MMC バージョン 1.2 で導入されました。

nImageINT4+16+8

項目が非選択状態のときに使用される、イメージ リスト内の仮想イメージ インデックスです。仮想イメージ インデックスは内部で実際のインデックスにマップされることに注意してください。このメンバーは、コールバック項目 (MMC_CALLBACK または MMC_IMAGECALLBACK) として指定することもできます。MMC_IMAGECALLBACK は、MMC_CALLBACK の型が正しい (キャストが不要な) バージョンです。

MMC_IMAGECALLBACK は MMC バージョン 1.2 で導入されました。

nOpenImageINT4+20+12項目が選択状態のときに使用される、イメージ リスト内の仮想イメージ インデックスです。仮想イメージ インデックスは内部で実際のインデックスにマップされることに注意してください。この項目は Microsoft Windows エクスプローラーのフォルダーのようなもので、このアイコンは開いた状態のフォルダーを表します。
nStateDWORD4+24+16

項目の状態マスクを指定する値です。IConsoleNameSpace2::GetItem の場合、このメンバーは、項目が 1 回以上展開されていれば MMC_SCOPE_ITEM_STATE_EXPANDEDONCE を返し、展開されていなければ 0 を返します。

このメンバーは、IConsoleNameSpace2::InsertItem および IConsoleNameSpace2::SetItem では無視されます。

cChildrenINT4+28+20

列挙される項目の数を指定する値です。

スナップインがスコープ項目を挿入する際、次の両方の条件を満たす場合は、cChildren フィールドを 0 に設定し、SDI_CHILDREN フラグを設定してください。

  • 挿入した項目の下に追加する子項目がスナップインに存在しない。
  • この項目に対して、スナップインが名前空間拡張スナップインを動的に有効化しない。
それ以外の場合、スコープ項目を挿入するときは、cChildren フィールドを 1 に設定するか、まったく設定しないでください。

後で条件が変化した場合、スナップインは IConsoleNameSpace2::SetItem を使用して cChildren フィールドを変更できます。

子項目の数を確定するのに時間がかかる場合、スナップインは挿入時には最良の推定値を使用し、MMC のユーザー インターフェイスがロックされないように別のスレッドで実際の数を確定してください。必要に応じて IConsoleNameSpace2::SetItem を使用して設定を修正できます。

MMC は、cChildren の数が 0 のスコープ項目を検出すると、ユーザーまたは IRequiredExtensions インターフェイスによってその項目に対して静的に有効化された名前空間拡張がないかを確認します。いずれも有効化されていない場合、その項目からプラス記号 (+) が削除されます。

項目が展開された後は、プラス記号の状態は実際に存在する子項目の数によって決まります。

lParamLPARAM8/4+32+24項目に関連付ける、ユーザー指定の 32 ビット値を指定する値です。この値はクッキーとも呼ばれ、 IComponentData::QueryDataObject の最初のパラメーターとして渡される値です。
relativeIDINT_PTR8/4+40+28

コンソールが提供する一意の項目識別子です。項目は、このメンバーが指定する項目を基準とした位置に挿入されます。相対的な位置は mask の設定によって決まります。

relativeID がどのように解釈されるかを決めるには、mask メンバーとして次の定数のいずれかを指定します。

SDI_PARENT

relativeID は親の HSCOPEITEM です。項目は親項目の最後の子として挿入されます。既定では親項目の ID が relativeID であるため、SDI_PARENT の値は何も行わないことを示します。

SDI_PREVIOUS

relativeID は前の兄弟の HSCOPEITEM です。

SDI_NEXT

relativeID は次の兄弟の HSCOPEITEM です。

SDI_FIRST

SDI_PARENT と同じですが、項目は最初の子として挿入されます。

IDINT_PTR8/4+48+32

スコープ項目に対してコンソールが提供する一意の識別子を指定する値です。この値は、 IConsole2 インターフェイスおよび IConsoleNameSpace2 インターフェイスの一部のメソッドの呼び出しにおいて、スコープ ペイン内の項目を識別するために使用されます。

スナップインが (IConsoleNameSpace2::InsertItem を使用して) スコープ ペインへの項目の挿入に成功すると、 SCOPEDATAITEM 構造体の ID メンバーには、新しく挿入された項目の HSCOPEITEM ハンドルが格納されます。このハンドルがスコープ項目の一意の識別子です。

静的ノードの場合、MMC はスナップインのスコープ ペインに項目を挿入します。その後、MMC は静的ノードの HSCOPEITEM を MMCN_EXPAND 通知の param パラメーターとしてスナップインに渡します。

スナップインは、挿入した各項目の HSCOPEITEM を保存し、後で IConsole2 インターフェイスおよび IConsoleNameSpace2 インターフェイスのメソッドを使用して項目を操作する際に使用する必要があることに注意してください。

公式ドキュメント

SCOPEDATAITEM 構造体は、スコープ ペインに挿入する項目を指定します。

解説(Remarks)

静的ノードの兄弟として項目を挿入することはできません。スナップインが relativeID メンバーに静的ノードの HSCOPEITEM を設定し、SDI_PREVIOUS または SDI_NEXT フラグを設定して IConsoleNameSpace2::InsertItem を呼び出すと、MMC は E_INVALIDARG を返します。

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

各言語での定義

#include <windows.h>

// SCOPEDATAITEM  (x64 56 / x86 36 バイト)
typedef struct SCOPEDATAITEM {
    DWORD mask;
    LPWSTR displayname;
    INT nImage;
    INT nOpenImage;
    DWORD nState;
    INT cChildren;
    LPARAM lParam;
    INT_PTR relativeID;
    INT_PTR ID;
} SCOPEDATAITEM;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SCOPEDATAITEM
{
    public uint mask;
    public IntPtr displayname;
    public int nImage;
    public int nOpenImage;
    public uint nState;
    public int cChildren;
    public IntPtr lParam;
    public IntPtr relativeID;
    public IntPtr ID;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SCOPEDATAITEM
    Public mask As UInteger
    Public displayname As IntPtr
    Public nImage As Integer
    Public nOpenImage As Integer
    Public nState As UInteger
    Public cChildren As Integer
    Public lParam As IntPtr
    Public relativeID As IntPtr
    Public ID As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class SCOPEDATAITEM(ctypes.Structure):
    _fields_ = [
        ("mask", wintypes.DWORD),
        ("displayname", ctypes.c_void_p),
        ("nImage", ctypes.c_int),
        ("nOpenImage", ctypes.c_int),
        ("nState", wintypes.DWORD),
        ("cChildren", ctypes.c_int),
        ("lParam", ctypes.c_ssize_t),
        ("relativeID", ctypes.c_ssize_t),
        ("ID", ctypes.c_ssize_t),
    ]
#[repr(C)]
pub struct SCOPEDATAITEM {
    pub mask: u32,
    pub displayname: *mut core::ffi::c_void,
    pub nImage: i32,
    pub nOpenImage: i32,
    pub nState: u32,
    pub cChildren: i32,
    pub lParam: isize,
    pub relativeID: isize,
    pub ID: isize,
}
import "golang.org/x/sys/windows"

type SCOPEDATAITEM struct {
	mask uint32
	displayname uintptr
	nImage int32
	nOpenImage int32
	nState uint32
	cChildren int32
	lParam uintptr
	relativeID uintptr
	ID uintptr
}
type
  SCOPEDATAITEM = record
    mask: DWORD;
    displayname: Pointer;
    nImage: Integer;
    nOpenImage: Integer;
    nState: DWORD;
    cChildren: Integer;
    lParam: NativeInt;
    relativeID: NativeInt;
    ID: NativeInt;
  end;
const SCOPEDATAITEM = extern struct {
    mask: u32,
    displayname: ?*anyopaque,
    nImage: i32,
    nOpenImage: i32,
    nState: u32,
    cChildren: i32,
    lParam: isize,
    relativeID: isize,
    ID: isize,
};
type
  SCOPEDATAITEM {.bycopy.} = object
    mask: uint32
    displayname: pointer
    nImage: int32
    nOpenImage: int32
    nState: uint32
    cChildren: int32
    lParam: int
    relativeID: int
    ID: int
struct SCOPEDATAITEM
{
    uint mask;
    void* displayname;
    int nImage;
    int nOpenImage;
    uint nState;
    int cChildren;
    ptrdiff_t lParam;
    ptrdiff_t relativeID;
    ptrdiff_t ID;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SCOPEDATAITEM サイズ: 36 バイト(x86)
dim st, 9    ; 4byte整数×9(構造体サイズ 36 / 4 切り上げ)
; mask : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; displayname : LPWSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; nImage : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; nOpenImage : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; nState : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cChildren : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; lParam : LPARAM (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; relativeID : INT_PTR (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ID : INT_PTR (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SCOPEDATAITEM サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; mask : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; displayname : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; nImage : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; nOpenImage : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; nState : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; cChildren : INT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; lParam : LPARAM (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; relativeID : INT_PTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; ID : INT_PTR (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SCOPEDATAITEM
    #field int mask
    #field intptr displayname
    #field int nImage
    #field int nOpenImage
    #field int nState
    #field int cChildren
    #field intptr lParam
    #field intptr relativeID
    #field intptr ID
#endstruct

stdim st, SCOPEDATAITEM        ; NSTRUCT 変数を確保
st->mask = 100
mes "mask=" + st->mask