ホーム › NetworkManagement.NetShell › CMD_ENTRY
CMD_ENTRY
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| pwszCmdToken | LPWSTR | 8/4 | +0 | +0 | コマンドのトークン (名前) です。 |
| pfnCmdHandler | PFN_HANDLE_CMD | 8/4 | +8 | +4 | コマンドを処理する関数です。詳細については、 FN_HANDLE_CMD を参照してください。 |
| dwShortCmdHelpToken | DWORD | 4 | +16 | +8 | 短いヘルプメッセージです。これは、ヘルパー DLL のリソースファイル内のメッセージ識別子です。 |
| dwCmdHlpToken | DWORD | 4 | +20 | +12 | コマンドの後にヘルプトークン (HELP、/?、-?、または ?) のみが続く場合に表示するメッセージです。これは、ヘルパー DLL のリソースファイル内のメッセージ識別子です。 |
| dwFlags | DWORD | 4 | +24 | +16 | コマンドのフラグです。詳細については、 Netshell Flags を参照してください。 |
| pOsVersionCheck | PNS_OSVERSIONCHECK | 8/4 | +32 | +20 | オペレーティングシステムのバージョンチェック関数です。これは、コマンドを呼び出す、または表示する前に、そのコマンドをローカルおよびリモートのコンテキストで実行中のオペレーティングシステム上で実行できるかどうかを判断するために使用される関数です。詳細については、 NS_OSVERSIONCHECK を参照してください。 |
公式ドキュメント
CMD_ENTRY 構造体は、ヘルパーコマンドを定義します。
解説(Remarks)
次のように、 CMD_ENTRY 構造体の作成を簡略化できるマクロが用意されています。
#define CREATE_CMD_ENTRY_EX(t,f,i) {CMD_##t, f, HLP_##t, HLP_##t##_EX, i, NULL}
#define CREATE_CMD_ENTRY_EX_VER(t,f,i,v) {CMD_##t, f, HLP_##t, HLP_##t##_EX, i, v}
#define CREATE_CMD_ENTRY(t,f) {CMD_##t, f, HLP_##t, HLP_##t##_EX, CMD_FLAG_PRIVATE, NULL}
これらのマクロを使用する場合は、ヘルパー DLL 内に次の定数を定義する必要があります。
これらのマクロの使用例を次に示します。
#define HLP_SAMPLE_ADD_BAR 1001
#define HLP_SAMPLE_ADD_BAR_EX 1002
#define HLP_SAMPLE_DELETE_BAR 1003
#define HLP_SAMPLE_DELETE_BAR_EX 1004
#define HLP_SAMPLE_SET_GLOBAL 1005
#define HLP_SAMPLE_SET_GLOBAL_EX 1006
#define HLP_SAMPLE_SET_BAR 1007
#define HLP_SAMPLE_SET_BAR_EX 1008
#define HLP_SAMPLE_SET_FILTER 1009
#define HLP_SAMPLE_SET_FILTER_EX 1010
#define HLP_SAMPLE_SHOW_GLOBAL 1011
#define HLP_SAMPLE_SHOW_GLOBAL_EX 1012
#define HLP_SAMPLE_SHOW_BAR 1013
#define HLP_SAMPLE_SHOW_BAR_EX 1014
#define HLP_SAMPLE_SHOW_FILTER 1015
#define HLP_SAMPLE_SHOW_FILTER_EX 1016
#define CMD_SAMPLE_ADD_BAR L"add_bar"
#define CMD_SAMPLE_DELETE_BAR L"delete_bar"
#define CMD_SAMPLE_SET_GLOBAL L"set_global"
#define CMD_SAMPLE_SET_BAR L"set_bar"
#define CMD_SAMPLE_SET_FILTER L"set_filter"
#define CMD_SAMPLE_SHOW_GLOBAL L"show_global"
#define CMD_SAMPLE_SHOW_BAR L"show_bar"
#define CMD_SAMPLE_SHOW_FILTER L"show_filter"
CMD_ENTRY g_SampleAddCmdTable[] =
{
CREATE_CMD_ENTRY(SAMPLE_ADD_BAR, HandleSampleAddBar),
};
CMD_ENTRY g_SampleDeleteCmdTable[] =
{
CREATE_CMD_ENTRY(SAMPLE_DELETE_BAR, HandleSampleDeleteBar),
};
CMD_ENTRY g_SampleSetCmdTable[] =
{
CREATE_CMD_ENTRY(SAMPLE_SET_GLOBAL, HandleSampleSetGlobal),
CREATE_CMD_ENTRY_EX(SAMPLE_SET_BAR, HandleSampleSetBar, (CMD_FLAG_PRIVATE | CMD_FLAG_ONLINE) ),
CREATE_CMD_ENTRY_EX_VER(SAMPLE_SET_FILTER, HandleSampleSetFilter, (CMD_FLAG_PRIVATE | CMD_FLAG_ONLINE), CheckRunningOnWindowsXP),
};
CMD_ENTRY g_SampleShowCmdTable[] =
{
CREATE_CMD_ENTRY(SAMPLE_SHOW_GLOBAL, HandleSampleShowGlobal),
CREATE_CMD_ENTRY_EX(SAMPLE_SHOW_BAR, HandleSampleShowBar, (CMD_FLAG_PRIVATE | CMD_FLAG_ONLINE) ),
CREATE_CMD_ENTRY_EX_VER(SAMPLE_SHOW_FILTER, HandleSampleShowFilter, (CMD_FLAG_PRIVATE | CMD_FLAG_ONLINE), CheckRunningOnWindowsXP),
};
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// CMD_ENTRY (x64 40 / x86 24 バイト)
typedef struct CMD_ENTRY {
LPWSTR pwszCmdToken;
PFN_HANDLE_CMD pfnCmdHandler;
DWORD dwShortCmdHelpToken;
DWORD dwCmdHlpToken;
DWORD dwFlags;
PNS_OSVERSIONCHECK pOsVersionCheck;
} CMD_ENTRY;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CMD_ENTRY
{
public IntPtr pwszCmdToken;
public IntPtr pfnCmdHandler;
public uint dwShortCmdHelpToken;
public uint dwCmdHlpToken;
public uint dwFlags;
public IntPtr pOsVersionCheck;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CMD_ENTRY
Public pwszCmdToken As IntPtr
Public pfnCmdHandler As IntPtr
Public dwShortCmdHelpToken As UInteger
Public dwCmdHlpToken As UInteger
Public dwFlags As UInteger
Public pOsVersionCheck As IntPtr
End Structureimport ctypes
from ctypes import wintypes
class CMD_ENTRY(ctypes.Structure):
_fields_ = [
("pwszCmdToken", ctypes.c_void_p),
("pfnCmdHandler", ctypes.c_void_p),
("dwShortCmdHelpToken", wintypes.DWORD),
("dwCmdHlpToken", wintypes.DWORD),
("dwFlags", wintypes.DWORD),
("pOsVersionCheck", ctypes.c_void_p),
]#[repr(C)]
pub struct CMD_ENTRY {
pub pwszCmdToken: *mut core::ffi::c_void,
pub pfnCmdHandler: *mut core::ffi::c_void,
pub dwShortCmdHelpToken: u32,
pub dwCmdHlpToken: u32,
pub dwFlags: u32,
pub pOsVersionCheck: *mut core::ffi::c_void,
}import "golang.org/x/sys/windows"
type CMD_ENTRY struct {
pwszCmdToken uintptr
pfnCmdHandler uintptr
dwShortCmdHelpToken uint32
dwCmdHlpToken uint32
dwFlags uint32
pOsVersionCheck uintptr
}type
CMD_ENTRY = record
pwszCmdToken: Pointer;
pfnCmdHandler: Pointer;
dwShortCmdHelpToken: DWORD;
dwCmdHlpToken: DWORD;
dwFlags: DWORD;
pOsVersionCheck: Pointer;
end;const CMD_ENTRY = extern struct {
pwszCmdToken: ?*anyopaque,
pfnCmdHandler: ?*anyopaque,
dwShortCmdHelpToken: u32,
dwCmdHlpToken: u32,
dwFlags: u32,
pOsVersionCheck: ?*anyopaque,
};type
CMD_ENTRY {.bycopy.} = object
pwszCmdToken: pointer
pfnCmdHandler: pointer
dwShortCmdHelpToken: uint32
dwCmdHlpToken: uint32
dwFlags: uint32
pOsVersionCheck: pointerstruct CMD_ENTRY
{
void* pwszCmdToken;
void* pfnCmdHandler;
uint dwShortCmdHelpToken;
uint dwCmdHlpToken;
uint dwFlags;
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_ENTRY サイズ: 24 バイト(x86)
dim st, 6 ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; pwszCmdToken : LPWSTR (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; pfnCmdHandler : PFN_HANDLE_CMD (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; dwShortCmdHelpToken : DWORD (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; dwCmdHlpToken : DWORD (+12, 4byte) st.3 = 値 / 値 = st.3 (lpoke/lpeek も可)
; dwFlags : DWORD (+16, 4byte) st.4 = 値 / 値 = st.4 (lpoke/lpeek も可)
; 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_ENTRY サイズ: 40 バイト(x64)
dim st, 10 ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; pwszCmdToken : LPWSTR (+0, 8byte) qpoke st,0,値 / qpeek(st,0) ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; pfnCmdHandler : PFN_HANDLE_CMD (+8, 8byte) qpoke st,8,値 / qpeek(st,8) ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; dwShortCmdHelpToken : DWORD (+16, 4byte) st.4 = 値 / 値 = st.4 (lpoke/lpeek も可)
; dwCmdHlpToken : DWORD (+20, 4byte) st.5 = 値 / 値 = st.5 (lpoke/lpeek も可)
; dwFlags : DWORD (+24, 4byte) st.6 = 値 / 値 = st.6 (lpoke/lpeek も可)
; 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_ENTRY
#field intptr pwszCmdToken
#field intptr pfnCmdHandler
#field int dwShortCmdHelpToken
#field int dwCmdHlpToken
#field int dwFlags
#field intptr pOsVersionCheck
#endstruct
stdim st, CMD_ENTRY ; NSTRUCT 変数を確保
st->dwShortCmdHelpToken = 100
mes "dwShortCmdHelpToken=" + st->dwShortCmdHelpToken