ホーム › System.RemoteManagement › WSManReceiveShellOutput

WSManReceiveShellOutput

関数

リモートシェルの出力を非同期に受信する。

DLLWsmSvc.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

void WSManReceiveShellOutput(
    WSMAN_SHELL_HANDLE shell,
    WSMAN_COMMAND_HANDLE command,   // optional
    DWORD flags,
    WSMAN_STREAM_ID_SET* desiredStreamSet,   // optional
    WSMAN_SHELL_ASYNC* async,
    WSMAN_OPERATION_HANDLE* receiveOperation
);

パラメーター

名前	型	方向
shell	WSMAN_SHELL_HANDLE	in
command	WSMAN_COMMAND_HANDLE	inoptional
flags	DWORD	in
desiredStreamSet	WSMAN_STREAM_ID_SET*	inoptional
async	WSMAN_SHELL_ASYNC*	in
receiveOperation	WSMAN_OPERATION_HANDLE*	out

戻り値の型: void

各言語での呼び出し定義

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

void WSManReceiveShellOutput(
    WSMAN_SHELL_HANDLE shell,
    WSMAN_COMMAND_HANDLE command,   // optional
    DWORD flags,
    WSMAN_STREAM_ID_SET* desiredStreamSet,   // optional
    WSMAN_SHELL_ASYNC* async,
    WSMAN_OPERATION_HANDLE* receiveOperation
);

[DllImport("WsmSvc.dll", ExactSpelling = true)]
static extern void WSManReceiveShellOutput(
    IntPtr shell,   // WSMAN_SHELL_HANDLE
    IntPtr command,   // WSMAN_COMMAND_HANDLE optional
    uint flags,   // DWORD
    IntPtr desiredStreamSet,   // WSMAN_STREAM_ID_SET* optional
    IntPtr async,   // WSMAN_SHELL_ASYNC*
    out IntPtr receiveOperation   // WSMAN_OPERATION_HANDLE* out
);

<DllImport("WsmSvc.dll", ExactSpelling:=True)>
Public Shared Sub WSManReceiveShellOutput(
    shell As IntPtr,   ' WSMAN_SHELL_HANDLE
    command As IntPtr,   ' WSMAN_COMMAND_HANDLE optional
    flags As UInteger,   ' DWORD
    desiredStreamSet As IntPtr,   ' WSMAN_STREAM_ID_SET* optional
    async As IntPtr,   ' WSMAN_SHELL_ASYNC*
    <Out> ByRef receiveOperation As IntPtr   ' WSMAN_OPERATION_HANDLE* out
)
End Sub

' shell : WSMAN_SHELL_HANDLE
' command : WSMAN_COMMAND_HANDLE optional
' flags : DWORD
' desiredStreamSet : WSMAN_STREAM_ID_SET* optional
' async : WSMAN_SHELL_ASYNC*
' receiveOperation : WSMAN_OPERATION_HANDLE* out
Declare PtrSafe Sub WSManReceiveShellOutput Lib "wsmsvc" ( _
    ByVal shell As LongPtr, _
    ByVal command As LongPtr, _
    ByVal flags As Long, _
    ByVal desiredStreamSet As LongPtr, _
    ByVal async As LongPtr, _
    ByRef receiveOperation As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSManReceiveShellOutput = ctypes.windll.wsmsvc.WSManReceiveShellOutput
WSManReceiveShellOutput.restype = None
WSManReceiveShellOutput.argtypes = [
    ctypes.c_ssize_t,  # shell : WSMAN_SHELL_HANDLE
    ctypes.c_ssize_t,  # command : WSMAN_COMMAND_HANDLE optional
    wintypes.DWORD,  # flags : DWORD
    ctypes.c_void_p,  # desiredStreamSet : WSMAN_STREAM_ID_SET* optional
    ctypes.c_void_p,  # async : WSMAN_SHELL_ASYNC*
    ctypes.c_void_p,  # receiveOperation : WSMAN_OPERATION_HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WsmSvc.dll')
WSManReceiveShellOutput = Fiddle::Function.new(
  lib['WSManReceiveShellOutput'],
  [
    Fiddle::TYPE_INTPTR_T,  # shell : WSMAN_SHELL_HANDLE
    Fiddle::TYPE_INTPTR_T,  # command : WSMAN_COMMAND_HANDLE optional
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # desiredStreamSet : WSMAN_STREAM_ID_SET* optional
    Fiddle::TYPE_VOIDP,  # async : WSMAN_SHELL_ASYNC*
    Fiddle::TYPE_VOIDP,  # receiveOperation : WSMAN_OPERATION_HANDLE* out
  ],
  Fiddle::TYPE_VOID)

#[link(name = "wsmsvc")]
extern "system" {
    fn WSManReceiveShellOutput(
        shell: isize,  // WSMAN_SHELL_HANDLE
        command: isize,  // WSMAN_COMMAND_HANDLE optional
        flags: u32,  // DWORD
        desiredStreamSet: *mut WSMAN_STREAM_ID_SET,  // WSMAN_STREAM_ID_SET* optional
        async: *mut WSMAN_SHELL_ASYNC,  // WSMAN_SHELL_ASYNC*
        receiveOperation: *mut isize  // WSMAN_OPERATION_HANDLE* out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WsmSvc.dll")]
public static extern void WSManReceiveShellOutput(IntPtr shell, IntPtr command, uint flags, IntPtr desiredStreamSet, IntPtr async, out IntPtr receiveOperation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WsmSvc_WSManReceiveShellOutput' -Namespace Win32 -PassThru
# $api::WSManReceiveShellOutput(shell, command, flags, desiredStreamSet, async, receiveOperation)

#uselib "WsmSvc.dll"
#func global WSManReceiveShellOutput "WSManReceiveShellOutput" sptr, sptr, sptr, sptr, sptr, sptr
; WSManReceiveShellOutput shell, command, flags, varptr(desiredStreamSet), varptr(async), receiveOperation
; shell : WSMAN_SHELL_HANDLE -> "sptr"
; command : WSMAN_COMMAND_HANDLE optional -> "sptr"
; flags : DWORD -> "sptr"
; desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "sptr"
; async : WSMAN_SHELL_ASYNC* -> "sptr"
; receiveOperation : WSMAN_OPERATION_HANDLE* out -> "sptr"

出力引数:

#uselib "WsmSvc.dll"
#func global WSManReceiveShellOutput "WSManReceiveShellOutput" sptr, sptr, int, var, var, int
; WSManReceiveShellOutput shell, command, flags, desiredStreamSet, async, receiveOperation
; shell : WSMAN_SHELL_HANDLE -> "sptr"
; command : WSMAN_COMMAND_HANDLE optional -> "sptr"
; flags : DWORD -> "int"
; desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "var"
; async : WSMAN_SHELL_ASYNC* -> "var"
; receiveOperation : WSMAN_OPERATION_HANDLE* out -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WsmSvc.dll"
#func global WSManReceiveShellOutput "WSManReceiveShellOutput" sptr, sptr, int, sptr, sptr, int
; WSManReceiveShellOutput shell, command, flags, varptr(desiredStreamSet), varptr(async), receiveOperation
; shell : WSMAN_SHELL_HANDLE -> "sptr"
; command : WSMAN_COMMAND_HANDLE optional -> "sptr"
; flags : DWORD -> "int"
; desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "sptr"
; async : WSMAN_SHELL_ASYNC* -> "sptr"
; receiveOperation : WSMAN_OPERATION_HANDLE* out -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; void WSManReceiveShellOutput(WSMAN_SHELL_HANDLE shell, WSMAN_COMMAND_HANDLE command, DWORD flags, WSMAN_STREAM_ID_SET* desiredStreamSet, WSMAN_SHELL_ASYNC* async, WSMAN_OPERATION_HANDLE* receiveOperation)
#uselib "WsmSvc.dll"
#func global WSManReceiveShellOutput "WSManReceiveShellOutput" intptr, intptr, int, var, var, int
; WSManReceiveShellOutput shell, command, flags, desiredStreamSet, async, receiveOperation
; shell : WSMAN_SHELL_HANDLE -> "intptr"
; command : WSMAN_COMMAND_HANDLE optional -> "intptr"
; flags : DWORD -> "int"
; desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "var"
; async : WSMAN_SHELL_ASYNC* -> "var"
; receiveOperation : WSMAN_OPERATION_HANDLE* out -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; void WSManReceiveShellOutput(WSMAN_SHELL_HANDLE shell, WSMAN_COMMAND_HANDLE command, DWORD flags, WSMAN_STREAM_ID_SET* desiredStreamSet, WSMAN_SHELL_ASYNC* async, WSMAN_OPERATION_HANDLE* receiveOperation)
#uselib "WsmSvc.dll"
#func global WSManReceiveShellOutput "WSManReceiveShellOutput" intptr, intptr, int, intptr, intptr, int
; WSManReceiveShellOutput shell, command, flags, varptr(desiredStreamSet), varptr(async), receiveOperation
; shell : WSMAN_SHELL_HANDLE -> "intptr"
; command : WSMAN_COMMAND_HANDLE optional -> "intptr"
; flags : DWORD -> "int"
; desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "intptr"
; async : WSMAN_SHELL_ASYNC* -> "intptr"
; receiveOperation : WSMAN_OPERATION_HANDLE* out -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsmsvc = windows.NewLazySystemDLL("WsmSvc.dll")
	procWSManReceiveShellOutput = wsmsvc.NewProc("WSManReceiveShellOutput")
)

// shell (WSMAN_SHELL_HANDLE), command (WSMAN_COMMAND_HANDLE optional), flags (DWORD), desiredStreamSet (WSMAN_STREAM_ID_SET* optional), async (WSMAN_SHELL_ASYNC*), receiveOperation (WSMAN_OPERATION_HANDLE* out)
r1, _, err := procWSManReceiveShellOutput.Call(
	uintptr(shell),
	uintptr(command),
	uintptr(flags),
	uintptr(desiredStreamSet),
	uintptr(async),
	uintptr(receiveOperation),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void

procedure WSManReceiveShellOutput(
  shell: NativeInt;   // WSMAN_SHELL_HANDLE
  command: NativeInt;   // WSMAN_COMMAND_HANDLE optional
  flags: DWORD;   // DWORD
  desiredStreamSet: Pointer;   // WSMAN_STREAM_ID_SET* optional
  async: Pointer;   // WSMAN_SHELL_ASYNC*
  receiveOperation: Pointer   // WSMAN_OPERATION_HANDLE* out
); stdcall;
  external 'WsmSvc.dll' name 'WSManReceiveShellOutput';

result := DllCall("WsmSvc\WSManReceiveShellOutput"
    , "Ptr", shell   ; WSMAN_SHELL_HANDLE
    , "Ptr", command   ; WSMAN_COMMAND_HANDLE optional
    , "UInt", flags   ; DWORD
    , "Ptr", desiredStreamSet   ; WSMAN_STREAM_ID_SET* optional
    , "Ptr", async   ; WSMAN_SHELL_ASYNC*
    , "Ptr", receiveOperation   ; WSMAN_OPERATION_HANDLE* out
    , "Int")   ; return: void

●WSManReceiveShellOutput(shell, command, flags, desiredStreamSet, async, receiveOperation) = DLL("WsmSvc.dll", "int WSManReceiveShellOutput(int, int, dword, void*, void*, void*)")
# 呼び出し: WSManReceiveShellOutput(shell, command, flags, desiredStreamSet, async, receiveOperation)
# shell : WSMAN_SHELL_HANDLE -> "int"
# command : WSMAN_COMMAND_HANDLE optional -> "int"
# flags : DWORD -> "dword"
# desiredStreamSet : WSMAN_STREAM_ID_SET* optional -> "void*"
# async : WSMAN_SHELL_ASYNC* -> "void*"
# receiveOperation : WSMAN_OPERATION_HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。