Win32 API 日本語リファレンス
ホーム › NetworkManagement.NetShell › CMD_GROUP_ENTRY

CMD_GROUP_ENTRY

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

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

フィールド

フィールド型サイズx64x86説明
pwszCmdGroupTokenLPWSTR8/4+0+0コマンドグループのトークン (名前) です。
dwShortCmdHelpTokenDWORD4+8+4短いヘルプメッセージです。
ulCmdGroupSizeDWORD4+12+8コマンドグループ内の要素数です。
dwFlagsDWORD4+16+12フラグです。詳細については、 NetShell Flags を参照してください。
pCmdGroupCMD_ENTRY*8/4+24+16CMD_ENTRY 構造体の配列です。
pOsVersionCheckPNS_OSVERSIONCHECK8/4+32+20オペレーティングシステムのバージョンチェック関数です。これは、コマンドを呼び出したり表示したりする前に、ローカルおよびリモートのコンテキストで実行されているオペレーティングシステム上でそのコマンドを実行できるかどうかを判断するために使用される関数です。詳細については、 NS_OSVERSIONCHECK を参照してください。

公式ドキュメント

CMD_GROUP_ENTRY 構造体は、ヘルパーコマンドのグループを定義します。

解説(Remarks)

次のように、 CMD_GROUP_ENTRY 構造体の作成を簡素化できるマクロが用意されています。

#define CREATE_CMD_GROUP_ENTRY_EX(t,s,i)       {CMD_##t, HLP_##t, sizeof(s)/sizeof(CMD_ENTRY), i, s, NULL }
#define CREATE_CMD_GROUP_ENTRY_EX_VER(t,s,i,v) {CMD_##t, HLP_##t, sizeof(s)/sizeof(CMD_ENTRY), i, s, v }
#define CREATE_CMD_GROUP_ENTRY(t,s)            {CMD_##t, HLP_##t, sizeof(s)/sizeof(CMD_ENTRY), 0, s, NULL }

これらのマクロを使用する場合は、ヘルパー DLL 内で次の定数を定義する必要があります。

これらのマクロの使用例を次に示します。

#define HLP_GROUP_ADD        1100
#define HLP_GROUP_ADD_EX     1101
#define HLP_GROUP_DELETE     1102
#define HLP_GROUP_DELETE_EX  1103
#define HLP_GROUP_SET        1104
#define HLP_GROUP_SET_EX     1105
#define HLP_GROUP_SHOW       1106
#define HLP_GROUP_SHOW_EX    1107

#define CMD_GROUP_ADD        L"add"
#define CMD_GROUP_DELETE     L"delete"
#define CMD_GROUP_SET        L"set"
#define CMD_GROUP_SHOW       L"show"

static CMD_GROUP_ENTRY g_SampleGroupCmds[] = 
{
    CREATE_CMD_GROUP_ENTRY(GROUP_ADD,    g_SampleAddCmdTable),
    CREATE_CMD_GROUP_ENTRY(GROUP_DELETE, g_SampleDeleteCmdTable),
    CREATE_CMD_GROUP_ENTRY(GROUP_SET,    g_SampleSetCmdTable),
    CREATE_CMD_GROUP_ENTRY(GROUP_SHOW,   g_SampleShowCmdTable),
};
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// CMD_GROUP_ENTRY  (x64 40 / x86 24 バイト)
typedef struct CMD_GROUP_ENTRY {
    LPWSTR pwszCmdGroupToken;
    DWORD dwShortCmdHelpToken;
    DWORD ulCmdGroupSize;
    DWORD dwFlags;
    CMD_ENTRY* pCmdGroup;
    PNS_OSVERSIONCHECK pOsVersionCheck;
} CMD_GROUP_ENTRY;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CMD_GROUP_ENTRY
{
    public IntPtr pwszCmdGroupToken;
    public uint dwShortCmdHelpToken;
    public uint ulCmdGroupSize;
    public uint dwFlags;
    public IntPtr pCmdGroup;
    public IntPtr pOsVersionCheck;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CMD_GROUP_ENTRY
    Public pwszCmdGroupToken As IntPtr
    Public dwShortCmdHelpToken As UInteger
    Public ulCmdGroupSize As UInteger
    Public dwFlags As UInteger
    Public pCmdGroup As IntPtr
    Public pOsVersionCheck As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class CMD_GROUP_ENTRY(ctypes.Structure):
    _fields_ = [
        ("pwszCmdGroupToken", ctypes.c_void_p),
        ("dwShortCmdHelpToken", wintypes.DWORD),
        ("ulCmdGroupSize", wintypes.DWORD),
        ("dwFlags", wintypes.DWORD),
        ("pCmdGroup", ctypes.c_void_p),
        ("pOsVersionCheck", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct CMD_GROUP_ENTRY {
    pub pwszCmdGroupToken: *mut core::ffi::c_void,
    pub dwShortCmdHelpToken: u32,
    pub ulCmdGroupSize: u32,
    pub dwFlags: u32,
    pub pCmdGroup: *mut core::ffi::c_void,
    pub pOsVersionCheck: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type CMD_GROUP_ENTRY struct {
	pwszCmdGroupToken uintptr
	dwShortCmdHelpToken uint32
	ulCmdGroupSize uint32
	dwFlags uint32
	pCmdGroup uintptr
	pOsVersionCheck uintptr
}
type
  CMD_GROUP_ENTRY = record
    pwszCmdGroupToken: Pointer;
    dwShortCmdHelpToken: DWORD;
    ulCmdGroupSize: DWORD;
    dwFlags: DWORD;
    pCmdGroup: Pointer;
    pOsVersionCheck: Pointer;
  end;
const CMD_GROUP_ENTRY = extern struct {
    pwszCmdGroupToken: ?*anyopaque,
    dwShortCmdHelpToken: u32,
    ulCmdGroupSize: u32,
    dwFlags: u32,
    pCmdGroup: ?*anyopaque,
    pOsVersionCheck: ?*anyopaque,
};
type
  CMD_GROUP_ENTRY {.bycopy.} = object
    pwszCmdGroupToken: pointer
    dwShortCmdHelpToken: uint32
    ulCmdGroupSize: uint32
    dwFlags: uint32
    pCmdGroup: pointer
    pOsVersionCheck: pointer
struct CMD_GROUP_ENTRY
{
    void* pwszCmdGroupToken;
    uint dwShortCmdHelpToken;
    uint ulCmdGroupSize;
    uint dwFlags;
    void* pCmdGroup;
    void* pOsVersionCheck;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CMD_GROUP_ENTRY サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; pwszCmdGroupToken : LPWSTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwShortCmdHelpToken : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ulCmdGroupSize : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwFlags : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pCmdGroup : CMD_ENTRY* (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; pOsVersionCheck : PNS_OSVERSIONCHECK (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CMD_GROUP_ENTRY サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; pwszCmdGroupToken : LPWSTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; dwShortCmdHelpToken : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ulCmdGroupSize : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwFlags : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; pCmdGroup : CMD_ENTRY* (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; pOsVersionCheck : PNS_OSVERSIONCHECK (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CMD_GROUP_ENTRY
    #field intptr pwszCmdGroupToken
    #field int dwShortCmdHelpToken
    #field int ulCmdGroupSize
    #field int dwFlags
    #field intptr pCmdGroup
    #field intptr pOsVersionCheck
#endstruct

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