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

WSManPluginReceiveResult

関数
プラグインが受信操作の結果を返す。
DLLWsmSvc.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// WsmSvc.dll
#include <windows.h>

DWORD WSManPluginReceiveResult(
    WSMAN_PLUGIN_REQUEST* requestDetails,
    DWORD flags,
    LPCWSTR stream,   // optional
    WSMAN_DATA* streamResult,   // optional
    LPCWSTR commandState,   // optional
    DWORD exitCode
);

パラメーター

名前方向説明
requestDetailsWSMAN_PLUGIN_REQUEST*in操作要求の詳細を保持する WSMAN_PLUGIN_REQUEST 構造体へのポインター。
flagsDWORDin受信結果の動作を制御するフラグ。
streamLPCWSTRinoptional出力するストリームのIDを示す文字列。
streamResultWSMAN_DATA*inoptional送出するストリームデータを格納した WSMAN_DATA 構造体へのポインター。
commandStateLPCWSTRinoptionalコマンドの状態(running/done など)を示す文字列。
exitCodeDWORDinコマンドの終了コード。commandState が done のとき有効となる。

戻り値の型: DWORD

各言語での呼び出し定義

// WsmSvc.dll
#include <windows.h>

DWORD WSManPluginReceiveResult(
    WSMAN_PLUGIN_REQUEST* requestDetails,
    DWORD flags,
    LPCWSTR stream,   // optional
    WSMAN_DATA* streamResult,   // optional
    LPCWSTR commandState,   // optional
    DWORD exitCode
);
[DllImport("WsmSvc.dll", ExactSpelling = true)]
static extern uint WSManPluginReceiveResult(
    IntPtr requestDetails,   // WSMAN_PLUGIN_REQUEST*
    uint flags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string stream,   // LPCWSTR optional
    IntPtr streamResult,   // WSMAN_DATA* optional
    [MarshalAs(UnmanagedType.LPWStr)] string commandState,   // LPCWSTR optional
    uint exitCode   // DWORD
);
<DllImport("WsmSvc.dll", ExactSpelling:=True)>
Public Shared Function WSManPluginReceiveResult(
    requestDetails As IntPtr,   ' WSMAN_PLUGIN_REQUEST*
    flags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> stream As String,   ' LPCWSTR optional
    streamResult As IntPtr,   ' WSMAN_DATA* optional
    <MarshalAs(UnmanagedType.LPWStr)> commandState As String,   ' LPCWSTR optional
    exitCode As UInteger   ' DWORD
) As UInteger
End Function
' requestDetails : WSMAN_PLUGIN_REQUEST*
' flags : DWORD
' stream : LPCWSTR optional
' streamResult : WSMAN_DATA* optional
' commandState : LPCWSTR optional
' exitCode : DWORD
Declare PtrSafe Function WSManPluginReceiveResult Lib "wsmsvc" ( _
    ByVal requestDetails As LongPtr, _
    ByVal flags As Long, _
    ByVal stream As LongPtr, _
    ByVal streamResult As LongPtr, _
    ByVal commandState As LongPtr, _
    ByVal exitCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSManPluginReceiveResult = ctypes.windll.wsmsvc.WSManPluginReceiveResult
WSManPluginReceiveResult.restype = wintypes.DWORD
WSManPluginReceiveResult.argtypes = [
    ctypes.c_void_p,  # requestDetails : WSMAN_PLUGIN_REQUEST*
    wintypes.DWORD,  # flags : DWORD
    wintypes.LPCWSTR,  # stream : LPCWSTR optional
    ctypes.c_void_p,  # streamResult : WSMAN_DATA* optional
    wintypes.LPCWSTR,  # commandState : LPCWSTR optional
    wintypes.DWORD,  # exitCode : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WsmSvc.dll')
WSManPluginReceiveResult = Fiddle::Function.new(
  lib['WSManPluginReceiveResult'],
  [
    Fiddle::TYPE_VOIDP,  # requestDetails : WSMAN_PLUGIN_REQUEST*
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # stream : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # streamResult : WSMAN_DATA* optional
    Fiddle::TYPE_VOIDP,  # commandState : LPCWSTR optional
    -Fiddle::TYPE_INT,  # exitCode : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wsmsvc")]
extern "system" {
    fn WSManPluginReceiveResult(
        requestDetails: *mut WSMAN_PLUGIN_REQUEST,  // WSMAN_PLUGIN_REQUEST*
        flags: u32,  // DWORD
        stream: *const u16,  // LPCWSTR optional
        streamResult: *mut WSMAN_DATA,  // WSMAN_DATA* optional
        commandState: *const u16,  // LPCWSTR optional
        exitCode: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WsmSvc.dll")]
public static extern uint WSManPluginReceiveResult(IntPtr requestDetails, uint flags, [MarshalAs(UnmanagedType.LPWStr)] string stream, IntPtr streamResult, [MarshalAs(UnmanagedType.LPWStr)] string commandState, uint exitCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WsmSvc_WSManPluginReceiveResult' -Namespace Win32 -PassThru
# $api::WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
#uselib "WsmSvc.dll"
#func global WSManPluginReceiveResult "WSManPluginReceiveResult" sptr, sptr, sptr, sptr, sptr, sptr
; WSManPluginReceiveResult varptr(requestDetails), flags, stream, varptr(streamResult), commandState, exitCode   ; 戻り値は stat
; requestDetails : WSMAN_PLUGIN_REQUEST* -> "sptr"
; flags : DWORD -> "sptr"
; stream : LPCWSTR optional -> "sptr"
; streamResult : WSMAN_DATA* optional -> "sptr"
; commandState : LPCWSTR optional -> "sptr"
; exitCode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WsmSvc.dll"
#cfunc global WSManPluginReceiveResult "WSManPluginReceiveResult" var, int, wstr, var, wstr, int
; res = WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
; requestDetails : WSMAN_PLUGIN_REQUEST* -> "var"
; flags : DWORD -> "int"
; stream : LPCWSTR optional -> "wstr"
; streamResult : WSMAN_DATA* optional -> "var"
; commandState : LPCWSTR optional -> "wstr"
; exitCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WSManPluginReceiveResult(WSMAN_PLUGIN_REQUEST* requestDetails, DWORD flags, LPCWSTR stream, WSMAN_DATA* streamResult, LPCWSTR commandState, DWORD exitCode)
#uselib "WsmSvc.dll"
#cfunc global WSManPluginReceiveResult "WSManPluginReceiveResult" var, int, wstr, var, wstr, int
; res = WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
; requestDetails : WSMAN_PLUGIN_REQUEST* -> "var"
; flags : DWORD -> "int"
; stream : LPCWSTR optional -> "wstr"
; streamResult : WSMAN_DATA* optional -> "var"
; commandState : LPCWSTR optional -> "wstr"
; exitCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsmsvc = windows.NewLazySystemDLL("WsmSvc.dll")
	procWSManPluginReceiveResult = wsmsvc.NewProc("WSManPluginReceiveResult")
)

// requestDetails (WSMAN_PLUGIN_REQUEST*), flags (DWORD), stream (LPCWSTR optional), streamResult (WSMAN_DATA* optional), commandState (LPCWSTR optional), exitCode (DWORD)
r1, _, err := procWSManPluginReceiveResult.Call(
	uintptr(requestDetails),
	uintptr(flags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(stream))),
	uintptr(streamResult),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(commandState))),
	uintptr(exitCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WSManPluginReceiveResult(
  requestDetails: Pointer;   // WSMAN_PLUGIN_REQUEST*
  flags: DWORD;   // DWORD
  stream: PWideChar;   // LPCWSTR optional
  streamResult: Pointer;   // WSMAN_DATA* optional
  commandState: PWideChar;   // LPCWSTR optional
  exitCode: DWORD   // DWORD
): DWORD; stdcall;
  external 'WsmSvc.dll' name 'WSManPluginReceiveResult';
result := DllCall("WsmSvc\WSManPluginReceiveResult"
    , "Ptr", requestDetails   ; WSMAN_PLUGIN_REQUEST*
    , "UInt", flags   ; DWORD
    , "WStr", stream   ; LPCWSTR optional
    , "Ptr", streamResult   ; WSMAN_DATA* optional
    , "WStr", commandState   ; LPCWSTR optional
    , "UInt", exitCode   ; DWORD
    , "UInt")   ; return: DWORD
●WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode) = DLL("WsmSvc.dll", "dword WSManPluginReceiveResult(void*, dword, char*, void*, char*, dword)")
# 呼び出し: WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
# requestDetails : WSMAN_PLUGIN_REQUEST* -> "void*"
# flags : DWORD -> "dword"
# stream : LPCWSTR optional -> "char*"
# streamResult : WSMAN_DATA* optional -> "void*"
# commandState : LPCWSTR optional -> "char*"
# exitCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wsmsvc" fn WSManPluginReceiveResult(
    requestDetails: [*c]WSMAN_PLUGIN_REQUEST, // WSMAN_PLUGIN_REQUEST*
    flags: u32, // DWORD
    stream: [*c]const u16, // LPCWSTR optional
    streamResult: [*c]WSMAN_DATA, // WSMAN_DATA* optional
    commandState: [*c]const u16, // LPCWSTR optional
    exitCode: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc WSManPluginReceiveResult(
    requestDetails: ptr WSMAN_PLUGIN_REQUEST,  # WSMAN_PLUGIN_REQUEST*
    flags: uint32,  # DWORD
    stream: WideCString,  # LPCWSTR optional
    streamResult: ptr WSMAN_DATA,  # WSMAN_DATA* optional
    commandState: WideCString,  # LPCWSTR optional
    exitCode: uint32  # DWORD
): uint32 {.importc: "WSManPluginReceiveResult", stdcall, dynlib: "WsmSvc.dll".}
pragma(lib, "wsmsvc");
extern(Windows)
uint WSManPluginReceiveResult(
    WSMAN_PLUGIN_REQUEST* requestDetails,   // WSMAN_PLUGIN_REQUEST*
    uint flags,   // DWORD
    const(wchar)* stream,   // LPCWSTR optional
    WSMAN_DATA* streamResult,   // WSMAN_DATA* optional
    const(wchar)* commandState,   // LPCWSTR optional
    uint exitCode   // DWORD
);
ccall((:WSManPluginReceiveResult, "WsmSvc.dll"), stdcall, UInt32,
      (Ptr{WSMAN_PLUGIN_REQUEST}, UInt32, Cwstring, Ptr{WSMAN_DATA}, Cwstring, UInt32),
      requestDetails, flags, stream, streamResult, commandState, exitCode)
# requestDetails : WSMAN_PLUGIN_REQUEST* -> Ptr{WSMAN_PLUGIN_REQUEST}
# flags : DWORD -> UInt32
# stream : LPCWSTR optional -> Cwstring
# streamResult : WSMAN_DATA* optional -> Ptr{WSMAN_DATA}
# commandState : LPCWSTR optional -> Cwstring
# exitCode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WSManPluginReceiveResult(
    void* requestDetails,
    uint32_t flags,
    const uint16_t* stream,
    void* streamResult,
    const uint16_t* commandState,
    uint32_t exitCode);
]]
local wsmsvc = ffi.load("wsmsvc")
-- wsmsvc.WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
-- requestDetails : WSMAN_PLUGIN_REQUEST*
-- flags : DWORD
-- stream : LPCWSTR optional
-- streamResult : WSMAN_DATA* optional
-- commandState : LPCWSTR optional
-- exitCode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WsmSvc.dll');
const WSManPluginReceiveResult = lib.func('__stdcall', 'WSManPluginReceiveResult', 'uint32_t', ['void *', 'uint32_t', 'str16', 'void *', 'str16', 'uint32_t']);
// WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
// requestDetails : WSMAN_PLUGIN_REQUEST* -> 'void *'
// flags : DWORD -> 'uint32_t'
// stream : LPCWSTR optional -> 'str16'
// streamResult : WSMAN_DATA* optional -> 'void *'
// commandState : LPCWSTR optional -> 'str16'
// exitCode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WsmSvc.dll", {
  WSManPluginReceiveResult: { parameters: ["pointer", "u32", "buffer", "pointer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode)
// requestDetails : WSMAN_PLUGIN_REQUEST* -> "pointer"
// flags : DWORD -> "u32"
// stream : LPCWSTR optional -> "buffer"
// streamResult : WSMAN_DATA* optional -> "pointer"
// commandState : LPCWSTR optional -> "buffer"
// exitCode : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WSManPluginReceiveResult(
    void* requestDetails,
    uint32_t flags,
    const uint16_t* stream,
    void* streamResult,
    const uint16_t* commandState,
    uint32_t exitCode);
C, "WsmSvc.dll");
// $ffi->WSManPluginReceiveResult(requestDetails, flags, stream, streamResult, commandState, exitCode);
// requestDetails : WSMAN_PLUGIN_REQUEST*
// flags : DWORD
// stream : LPCWSTR optional
// streamResult : WSMAN_DATA* optional
// commandState : LPCWSTR optional
// exitCode : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wsmsvc extends StdCallLibrary {
    Wsmsvc INSTANCE = Native.load("wsmsvc", Wsmsvc.class);
    int WSManPluginReceiveResult(
        Pointer requestDetails,   // WSMAN_PLUGIN_REQUEST*
        int flags,   // DWORD
        WString stream,   // LPCWSTR optional
        Pointer streamResult,   // WSMAN_DATA* optional
        WString commandState,   // LPCWSTR optional
        int exitCode   // DWORD
    );
}
@[Link("wsmsvc")]
lib LibWsmSvc
  fun WSManPluginReceiveResult = WSManPluginReceiveResult(
    requestDetails : WSMAN_PLUGIN_REQUEST*,   # WSMAN_PLUGIN_REQUEST*
    flags : UInt32,   # DWORD
    stream : UInt16*,   # LPCWSTR optional
    streamResult : WSMAN_DATA*,   # WSMAN_DATA* optional
    commandState : UInt16*,   # LPCWSTR optional
    exitCode : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSManPluginReceiveResultNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Uint32);
typedef WSManPluginReceiveResultDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, int);
final WSManPluginReceiveResult = DynamicLibrary.open('WsmSvc.dll')
    .lookupFunction<WSManPluginReceiveResultNative, WSManPluginReceiveResultDart>('WSManPluginReceiveResult');
// requestDetails : WSMAN_PLUGIN_REQUEST* -> Pointer<Void>
// flags : DWORD -> Uint32
// stream : LPCWSTR optional -> Pointer<Utf16>
// streamResult : WSMAN_DATA* optional -> Pointer<Void>
// commandState : LPCWSTR optional -> Pointer<Utf16>
// exitCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSManPluginReceiveResult(
  requestDetails: Pointer;   // WSMAN_PLUGIN_REQUEST*
  flags: DWORD;   // DWORD
  stream: PWideChar;   // LPCWSTR optional
  streamResult: Pointer;   // WSMAN_DATA* optional
  commandState: PWideChar;   // LPCWSTR optional
  exitCode: DWORD   // DWORD
): DWORD; stdcall;
  external 'WsmSvc.dll' name 'WSManPluginReceiveResult';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSManPluginReceiveResult"
  c_WSManPluginReceiveResult :: Ptr () -> Word32 -> CWString -> Ptr () -> CWString -> Word32 -> IO Word32
-- requestDetails : WSMAN_PLUGIN_REQUEST* -> Ptr ()
-- flags : DWORD -> Word32
-- stream : LPCWSTR optional -> CWString
-- streamResult : WSMAN_DATA* optional -> Ptr ()
-- commandState : LPCWSTR optional -> CWString
-- exitCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsmanpluginreceiveresult =
  foreign "WSManPluginReceiveResult"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* requestDetails : WSMAN_PLUGIN_REQUEST* -> (ptr void) *)
(* flags : DWORD -> uint32_t *)
(* stream : LPCWSTR optional -> (ptr uint16_t) *)
(* streamResult : WSMAN_DATA* optional -> (ptr void) *)
(* commandState : LPCWSTR optional -> (ptr uint16_t) *)
(* exitCode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsmsvc (t "WsmSvc.dll"))
(cffi:use-foreign-library wsmsvc)

(cffi:defcfun ("WSManPluginReceiveResult" wsman-plugin-receive-result :convention :stdcall) :uint32
  (request-details :pointer)   ; WSMAN_PLUGIN_REQUEST*
  (flags :uint32)   ; DWORD
  (stream (:string :encoding :utf-16le))   ; LPCWSTR optional
  (stream-result :pointer)   ; WSMAN_DATA* optional
  (command-state (:string :encoding :utf-16le))   ; LPCWSTR optional
  (exit-code :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSManPluginReceiveResult = Win32::API::More->new('WsmSvc',
    'DWORD WSManPluginReceiveResult(LPVOID requestDetails, DWORD flags, LPCWSTR stream, LPVOID streamResult, LPCWSTR commandState, DWORD exitCode)');
# my $ret = $WSManPluginReceiveResult->Call($requestDetails, $flags, $stream, $streamResult, $commandState, $exitCode);
# requestDetails : WSMAN_PLUGIN_REQUEST* -> LPVOID
# flags : DWORD -> DWORD
# stream : LPCWSTR optional -> LPCWSTR
# streamResult : WSMAN_DATA* optional -> LPVOID
# commandState : LPCWSTR optional -> LPCWSTR
# exitCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型