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

WSMAN_PLUGIN_REQUEST

構造体
サイズx64: 56 バイト / x86: 28 バイト

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

フィールド

フィールドサイズx64x86説明
senderDetailsWSMAN_SENDER_DETAILS*8/4+0+0要求を開始したクライアントに関する詳細を指定する WSMAN_SENDER_DETAILS 構造体へのポインターです。
localeLPWSTR8/4+8+4

ユーザーが結果に対して要求したロケールを指定します。要求されたロケールが利用できない場合は、次の選択肢があります。

  • システムのロケールが使用されます。
  • 要求は、無効なロケールを示すエラーで拒否されます。
プラグインへの呼び出しでは、スレッドのロケールがこのメンバーで指定されたロケールに設定されます。プラグインが要求の処理に他のスレッドを使用する場合は、使用する各スレッドに対してプラグイン側でロケールを適切に設定する必要があります。
resourceUriLPWSTR8/4+16+8この操作の リソース URI を指定します。
operationInfoWSMAN_OPERATION_INFO*8/4+24+12操作に関する追加情報を格納する WSMAN_OPERATION_INFO 構造体へのポインターです。すべてのパラメーターがすべての操作に関係するわけではないため、この構造体内の一部の情報は NULL になります。
shutdownNotificationBOOL4+32+16操作が取り消された場合、shutdownNotification メンバーは TRUE に設定されます。
shutdownNotificationHandleHANDLE8/4+40+20操作が取り消された場合、shutdownNotification がシグナル状態になります。
dataLocaleLPWSTR8/4+48+24データのロケール。LPWSTR型。NULL可。

公式ドキュメント

プラグイン要求の情報を指定します。WSMAN_PLUGIN_REQUEST 構造体へのポインターは、プラグイン内のすべての操作エントリポイントに渡されます。すべての結果通知メソッドは、このポインターを使用して結果と要求を対応付けます。この構造体内のすべての情報は、プラグインがその操作に対して WSManPluginOperationComplete を呼び出すまで有効なままです。

解説(Remarks)

操作は、シャットダウンされたことを示すために、その操作のコールバックをシグナル状態にする必要があります。操作は階層的に取り消され、最上位の操作よりも先に後続のすべての操作が取り消されるようになっています。プラグインが操作の取り消しを処理する方法は 2 つあります。1 つ目は、結果の集合を反復処理する場合に、プラグインが shutdownNotification のブール値を確認する方法です。2 つ目は、プラグインがより非同期的な性質を持つ場合に、非同期通知スレッドをキューに登録する際に shutdownNotificationHandle を使用する方法です。

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

各言語での定義

#include <windows.h>

// WSMAN_PLUGIN_REQUEST  (x64 56 / x86 28 バイト)
typedef struct WSMAN_PLUGIN_REQUEST {
    WSMAN_SENDER_DETAILS* senderDetails;
    LPWSTR locale;
    LPWSTR resourceUri;
    WSMAN_OPERATION_INFO* operationInfo;
    BOOL shutdownNotification;
    HANDLE shutdownNotificationHandle;
    LPWSTR dataLocale;
} WSMAN_PLUGIN_REQUEST;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WSMAN_PLUGIN_REQUEST
{
    public IntPtr senderDetails;
    public IntPtr locale;
    public IntPtr resourceUri;
    public IntPtr operationInfo;
    [MarshalAs(UnmanagedType.Bool)] public bool shutdownNotification;
    public IntPtr shutdownNotificationHandle;
    public IntPtr dataLocale;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WSMAN_PLUGIN_REQUEST
    Public senderDetails As IntPtr
    Public locale As IntPtr
    Public resourceUri As IntPtr
    Public operationInfo As IntPtr
    <MarshalAs(UnmanagedType.Bool)> Public shutdownNotification As Boolean
    Public shutdownNotificationHandle As IntPtr
    Public dataLocale As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class WSMAN_PLUGIN_REQUEST(ctypes.Structure):
    _fields_ = [
        ("senderDetails", ctypes.c_void_p),
        ("locale", ctypes.c_void_p),
        ("resourceUri", ctypes.c_void_p),
        ("operationInfo", ctypes.c_void_p),
        ("shutdownNotification", wintypes.BOOL),
        ("shutdownNotificationHandle", ctypes.c_void_p),
        ("dataLocale", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct WSMAN_PLUGIN_REQUEST {
    pub senderDetails: *mut core::ffi::c_void,
    pub locale: *mut core::ffi::c_void,
    pub resourceUri: *mut core::ffi::c_void,
    pub operationInfo: *mut core::ffi::c_void,
    pub shutdownNotification: i32,
    pub shutdownNotificationHandle: *mut core::ffi::c_void,
    pub dataLocale: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type WSMAN_PLUGIN_REQUEST struct {
	senderDetails uintptr
	locale uintptr
	resourceUri uintptr
	operationInfo uintptr
	shutdownNotification int32
	shutdownNotificationHandle uintptr
	dataLocale uintptr
}
type
  WSMAN_PLUGIN_REQUEST = record
    senderDetails: Pointer;
    locale: Pointer;
    resourceUri: Pointer;
    operationInfo: Pointer;
    shutdownNotification: BOOL;
    shutdownNotificationHandle: Pointer;
    dataLocale: Pointer;
  end;
const WSMAN_PLUGIN_REQUEST = extern struct {
    senderDetails: ?*anyopaque,
    locale: ?*anyopaque,
    resourceUri: ?*anyopaque,
    operationInfo: ?*anyopaque,
    shutdownNotification: i32,
    shutdownNotificationHandle: ?*anyopaque,
    dataLocale: ?*anyopaque,
};
type
  WSMAN_PLUGIN_REQUEST {.bycopy.} = object
    senderDetails: pointer
    locale: pointer
    resourceUri: pointer
    operationInfo: pointer
    shutdownNotification: int32
    shutdownNotificationHandle: pointer
    dataLocale: pointer
struct WSMAN_PLUGIN_REQUEST
{
    void* senderDetails;
    void* locale;
    void* resourceUri;
    void* operationInfo;
    int shutdownNotification;
    void* shutdownNotificationHandle;
    void* dataLocale;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WSMAN_PLUGIN_REQUEST サイズ: 28 バイト(x86)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; senderDetails : WSMAN_SENDER_DETAILS* (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; locale : LPWSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; resourceUri : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; operationInfo : WSMAN_OPERATION_INFO* (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; shutdownNotification : BOOL (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; shutdownNotificationHandle : HANDLE (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dataLocale : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WSMAN_PLUGIN_REQUEST サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; senderDetails : WSMAN_SENDER_DETAILS* (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; locale : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; resourceUri : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; operationInfo : WSMAN_OPERATION_INFO* (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; shutdownNotification : BOOL (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; shutdownNotificationHandle : HANDLE (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; dataLocale : LPWSTR (+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 WSMAN_PLUGIN_REQUEST
    #field intptr senderDetails
    #field intptr locale
    #field intptr resourceUri
    #field intptr operationInfo
    #field bool shutdownNotification
    #field intptr shutdownNotificationHandle
    #field intptr dataLocale
#endstruct

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