ホーム › NetworkManagement.NetShell › NS_CONTEXT_ATTRIBUTES

NS_CONTEXT_ATTRIBUTES

構造体

📘 Microsoft Learn (日本語) · English

サイズx64: 112 バイト / x86: 72 バイト

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

フィールド

型

サイズ

x64

x86

説明

Anonymous

_Anonymous_e__Union

バージョン情報を含む無名共用体。コンテキストの版数を保持する。

pwszContext

LPWSTR

8/4

新しいコンテキストを識別する Unicode 文字列です。この文字列は、ユーザーが使用できるコマンドになります。文字列にスペースを含めることはできません。

guidHelper

GUID

+16

+12

このヘルパーの GUID へのポインターです。 RegisterHelper 関数に渡される NS_HELPER_ATTRIBUTES 構造体の pguidHelper メンバーの値と同一です。

dwFlags

DWORD

+32

+28

このコンテキストが利用可能となる条件を制限するフラグのセットです。

フラグ	意味
CMD_FLAG_INTERACTIVE	設定されている場合、コンテキストは NetSh が対話モードで実行されているときにのみ利用可能であり、コマンドラインで NetSh に渡すことはできません。
CMD_FLAG_LOCAL	設定されている場合、コンテキストはリモートコンピューターからは有効ではありません。
CMD_FLAG_ONLINE	設定されている場合、コンテキストはオフラインモードでは有効ではありません。
CMD_FLAG_PRIORITY	設定されている場合、ulPriority フィールドが使用されます。

ulPriority

DWORD

+36

+32

ダンプコマンドおよびコミットコマンドの順序付けに使用される優先度の値です。dwFlags に CMD_FLAG_PRIORITY フラグが設定されている場合にのみ使用されます。既定値は DEFAULT_CONTEXT_PRIORITY で、NetSh.h で 100 と定義されています。値が小さいほど優先度が高くなります。

ulNumTopCmds

DWORD

+40

+36

pTopCmds メンバー内のエントリ数です。

pTopCmds

CMD_ENTRY*

8/4

+48

+40

ヘルパーコマンドを格納する CMD_ENTRY 構造体の配列です。

ulNumGroups

DWORD

+56

+44

pCmdGroups メンバー内のエントリ数です。

pCmdGroups

CMD_GROUP_ENTRY*

8/4

+64

+48

ヘルパーコマンドグループを格納する CMD_GROUP_ENTRY 構造体の配列です。

pfnCommitFn

PNS_CONTEXT_COMMIT_FN

8/4

+72

+52

オフラインモードでの変更をコミットするために呼び出される関数です。null を指定できます。コミット関数の詳細については、 NS_CONTEXT_COMMIT_FN を参照してください。

pfnDumpFn

PNS_CONTEXT_DUMP_FN

8/4

+80

+56

現在の構成をダンプするために呼び出される関数です。null を指定できます。ダンプ関数の詳細については、 NS_CONTEXT_DUMP_FN を参照してください。

pfnConnectFn

PNS_CONTEXT_CONNECT_FN

8/4

+88

+60

リモートコンピューターに接続する、または利用可能なコマンドのセットを更新するために呼び出される関数です。null を指定できます。接続関数の詳細については、NS_CONTEXT_CONNECT_FN を参照してください。

pReserved

void*

8/4

+96

+64

予約済みです。null でなければなりません。

pfnOsVersionCheck

PNS_OSVERSIONCHECK

8/4

+104

+68

コンテキストのOSバージョン適合性を確認するコールバックへのポインタ。

共用体: _Anonymous_e__Union x64 8B / x86 8B

フィールド	型	サイズ	x64	x86	説明
Anonymous	_Anonymous_e__Struct	8/4	+0	+0	バージョン情報を含む無名共用体。コンテキストの版数を保持する。
_ullAlign	ULONGLONG	8	+0	+0

公式ドキュメント

NS_CONTEXT_ATTRIBUTES 構造体は、コンテキストの属性を定義します。

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

各言語での定義

#include <windows.h>

// NS_CONTEXT_ATTRIBUTES  (x64 112 / x86 72 バイト)
typedef struct NS_CONTEXT_ATTRIBUTES {
    _Anonymous_e__Union Anonymous;
    LPWSTR pwszContext;
    GUID guidHelper;
    DWORD dwFlags;
    DWORD ulPriority;
    DWORD ulNumTopCmds;
    CMD_ENTRY* pTopCmds;
    DWORD ulNumGroups;
    CMD_GROUP_ENTRY* pCmdGroups;
    PNS_CONTEXT_COMMIT_FN pfnCommitFn;
    PNS_CONTEXT_DUMP_FN pfnDumpFn;
    PNS_CONTEXT_CONNECT_FN pfnConnectFn;
    void* pReserved;
    PNS_OSVERSIONCHECK pfnOsVersionCheck;
} NS_CONTEXT_ATTRIBUTES;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NS_CONTEXT_ATTRIBUTES
{
    public _Anonymous_e__Union Anonymous;
    public IntPtr pwszContext;
    public Guid guidHelper;
    public uint dwFlags;
    public uint ulPriority;
    public uint ulNumTopCmds;
    public IntPtr pTopCmds;
    public uint ulNumGroups;
    public IntPtr pCmdGroups;
    public IntPtr pfnCommitFn;
    public IntPtr pfnDumpFn;
    public IntPtr pfnConnectFn;
    public IntPtr pReserved;
    public IntPtr pfnOsVersionCheck;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NS_CONTEXT_ATTRIBUTES
    Public Anonymous As _Anonymous_e__Union
    Public pwszContext As IntPtr
    Public guidHelper As Guid
    Public dwFlags As UInteger
    Public ulPriority As UInteger
    Public ulNumTopCmds As UInteger
    Public pTopCmds As IntPtr
    Public ulNumGroups As UInteger
    Public pCmdGroups As IntPtr
    Public pfnCommitFn As IntPtr
    Public pfnDumpFn As IntPtr
    Public pfnConnectFn As IntPtr
    Public pReserved As IntPtr
    Public pfnOsVersionCheck As IntPtr
End Structure

import ctypes
from ctypes import wintypes

class NS_CONTEXT_ATTRIBUTES(ctypes.Structure):
    _fields_ = [
        ("Anonymous", _Anonymous_e__Union),
        ("pwszContext", ctypes.c_void_p),
        ("guidHelper", GUID),
        ("dwFlags", wintypes.DWORD),
        ("ulPriority", wintypes.DWORD),
        ("ulNumTopCmds", wintypes.DWORD),
        ("pTopCmds", ctypes.c_void_p),
        ("ulNumGroups", wintypes.DWORD),
        ("pCmdGroups", ctypes.c_void_p),
        ("pfnCommitFn", ctypes.c_void_p),
        ("pfnDumpFn", ctypes.c_void_p),
        ("pfnConnectFn", ctypes.c_void_p),
        ("pReserved", ctypes.c_void_p),
        ("pfnOsVersionCheck", ctypes.c_void_p),
    ]

#[repr(C)]
pub struct NS_CONTEXT_ATTRIBUTES {
    pub Anonymous: _Anonymous_e__Union,
    pub pwszContext: *mut core::ffi::c_void,
    pub guidHelper: GUID,
    pub dwFlags: u32,
    pub ulPriority: u32,
    pub ulNumTopCmds: u32,
    pub pTopCmds: *mut core::ffi::c_void,
    pub ulNumGroups: u32,
    pub pCmdGroups: *mut core::ffi::c_void,
    pub pfnCommitFn: *mut core::ffi::c_void,
    pub pfnDumpFn: *mut core::ffi::c_void,
    pub pfnConnectFn: *mut core::ffi::c_void,
    pub pReserved: *mut core::ffi::c_void,
    pub pfnOsVersionCheck: *mut core::ffi::c_void,
}

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

type NS_CONTEXT_ATTRIBUTES struct {
	Anonymous _Anonymous_e__Union
	pwszContext uintptr
	guidHelper windows.GUID
	dwFlags uint32
	ulPriority uint32
	ulNumTopCmds uint32
	pTopCmds uintptr
	ulNumGroups uint32
	pCmdGroups uintptr
	pfnCommitFn uintptr
	pfnDumpFn uintptr
	pfnConnectFn uintptr
	pReserved uintptr
	pfnOsVersionCheck uintptr
}

type
  NS_CONTEXT_ATTRIBUTES = record
    Anonymous: _Anonymous_e__Union;
    pwszContext: Pointer;
    guidHelper: TGUID;
    dwFlags: DWORD;
    ulPriority: DWORD;
    ulNumTopCmds: DWORD;
    pTopCmds: Pointer;
    ulNumGroups: DWORD;
    pCmdGroups: Pointer;
    pfnCommitFn: Pointer;
    pfnDumpFn: Pointer;
    pfnConnectFn: Pointer;
    pReserved: Pointer;
    pfnOsVersionCheck: Pointer;
  end;

const NS_CONTEXT_ATTRIBUTES = extern struct {
    Anonymous: _Anonymous_e__Union,
    pwszContext: ?*anyopaque,
    guidHelper: GUID,
    dwFlags: u32,
    ulPriority: u32,
    ulNumTopCmds: u32,
    pTopCmds: ?*anyopaque,
    ulNumGroups: u32,
    pCmdGroups: ?*anyopaque,
    pfnCommitFn: ?*anyopaque,
    pfnDumpFn: ?*anyopaque,
    pfnConnectFn: ?*anyopaque,
    pReserved: ?*anyopaque,
    pfnOsVersionCheck: ?*anyopaque,
};

type
  NS_CONTEXT_ATTRIBUTES {.bycopy.} = object
    Anonymous: _Anonymous_e__Union
    pwszContext: pointer
    guidHelper: GUID
    dwFlags: uint32
    ulPriority: uint32
    ulNumTopCmds: uint32
    pTopCmds: pointer
    ulNumGroups: uint32
    pCmdGroups: pointer
    pfnCommitFn: pointer
    pfnDumpFn: pointer
    pfnConnectFn: pointer
    pReserved: pointer
    pfnOsVersionCheck: pointer

struct NS_CONTEXT_ATTRIBUTES
{
    _Anonymous_e__Union Anonymous;
    void* pwszContext;
    GUID guidHelper;
    uint dwFlags;
    uint ulPriority;
    uint ulNumTopCmds;
    void* pTopCmds;
    uint ulNumGroups;
    void* pCmdGroups;
    void* pfnCommitFn;
    void* pfnDumpFn;
    void* pfnConnectFn;
    void* pReserved;
    void* pfnOsVersionCheck;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; NS_CONTEXT_ATTRIBUTES サイズ: 72 バイト(x86)
dim st, 18    ; 4byte整数×18(構造体サイズ 72 / 4 切り上げ)
; Anonymous : _Anonymous_e__Union (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; pwszContext : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; guidHelper : GUID (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; dwFlags : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ulPriority : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ulNumTopCmds : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; pTopCmds : CMD_ENTRY* (+40, 4byte)  varptr(st)+40 を基点に操作(4byte:入れ子/配列)
; ulNumGroups : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; pCmdGroups : CMD_GROUP_ENTRY* (+48, 4byte)  varptr(st)+48 を基点に操作(4byte:入れ子/配列)
; pfnCommitFn : PNS_CONTEXT_COMMIT_FN (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; pfnDumpFn : PNS_CONTEXT_DUMP_FN (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; pfnConnectFn : PNS_CONTEXT_CONNECT_FN (+60, 4byte)  st.15 = 値  /  値 = st.15   (lpoke/lpeek も可)
; pReserved : void* (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; pfnOsVersionCheck : PNS_OSVERSIONCHECK (+68, 4byte)  st.17 = 値  /  値 = st.17   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NS_CONTEXT_ATTRIBUTES サイズ: 112 バイト(x64)
dim st, 28    ; 4byte整数×28(構造体サイズ 112 / 4 切り上げ)
; Anonymous : _Anonymous_e__Union (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; pwszContext : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; guidHelper : GUID (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; dwFlags : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ulPriority : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; ulNumTopCmds : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; pTopCmds : CMD_ENTRY* (+48, 8byte)  varptr(st)+48 を基点に操作(8byte:入れ子/配列)
; ulNumGroups : DWORD (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; pCmdGroups : CMD_GROUP_ENTRY* (+64, 8byte)  varptr(st)+64 を基点に操作(8byte:入れ子/配列)
; pfnCommitFn : PNS_CONTEXT_COMMIT_FN (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; pfnDumpFn : PNS_CONTEXT_DUMP_FN (+80, 8byte)  qpoke st,80,値 / qpeek(st,80)  ※IronHSPのみ。3.7/3.8は lpoke st,80,下位 : lpoke st,84,上位
; pfnConnectFn : PNS_CONTEXT_CONNECT_FN (+88, 8byte)  qpoke st,88,値 / qpeek(st,88)  ※IronHSPのみ。3.7/3.8は lpoke st,88,下位 : lpoke st,92,上位
; pReserved : void* (+96, 8byte)  qpoke st,96,値 / qpeek(st,96)  ※IronHSPのみ。3.7/3.8は lpoke st,96,下位 : lpoke st,100,上位
; pfnOsVersionCheck : PNS_OSVERSIONCHECK (+104, 8byte)  qpoke st,104,値 / qpeek(st,104)  ※IronHSPのみ。3.7/3.8は lpoke st,104,下位 : lpoke st,108,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

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

#defstruct global NS_CONTEXT_ATTRIBUTES
    #field byte Anonymous 8
    #field intptr pwszContext
    #field GUID guidHelper
    #field int dwFlags
    #field int ulPriority
    #field int ulNumTopCmds
    #field intptr pTopCmds
    #field int ulNumGroups
    #field intptr pCmdGroups
    #field intptr pfnCommitFn
    #field intptr pfnDumpFn
    #field intptr pfnConnectFn
    #field intptr pReserved
    #field intptr pfnOsVersionCheck
#endstruct

stdim st, NS_CONTEXT_ATTRIBUTES        ; NSTRUCT 変数を確保
st->dwFlags = 100
mes "dwFlags=" + st->dwFlags
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。

NS_CONTEXT_ATTRIBUTES

フィールド

共用体: _Anonymous_e__Union x64 8B / x86 8B

公式ドキュメント

各言語での定義

HSP用 定義

HSP用定義