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

WSManGetSessionOptionAsString

関数
セッションオプションを文字列として取得する。
DLLWsmSvc.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD WSManGetSessionOptionAsString(
    WSMAN_SESSION_HANDLE session,
    WSManSessionOption option,
    DWORD stringLength,
    LPWSTR string,   // optional
    DWORD* stringLengthUsed
);

パラメーター

名前方向
sessionWSMAN_SESSION_HANDLEin
optionWSManSessionOptionin
stringLengthDWORDin
stringLPWSTRoutoptional
stringLengthUsedDWORD*out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WSManGetSessionOptionAsString(
    WSMAN_SESSION_HANDLE session,
    WSManSessionOption option,
    DWORD stringLength,
    LPWSTR string,   // optional
    DWORD* stringLengthUsed
);
[DllImport("WsmSvc.dll", ExactSpelling = true)]
static extern uint WSManGetSessionOptionAsString(
    IntPtr session,   // WSMAN_SESSION_HANDLE
    int option,   // WSManSessionOption
    uint stringLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder string,   // LPWSTR optional, out
    out uint stringLengthUsed   // DWORD* out
);
<DllImport("WsmSvc.dll", ExactSpelling:=True)>
Public Shared Function WSManGetSessionOptionAsString(
    session As IntPtr,   ' WSMAN_SESSION_HANDLE
    [option] As Integer,   ' WSManSessionOption
    stringLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> [string] As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef stringLengthUsed As UInteger   ' DWORD* out
) As UInteger
End Function
' session : WSMAN_SESSION_HANDLE
' option : WSManSessionOption
' stringLength : DWORD
' string : LPWSTR optional, out
' stringLengthUsed : DWORD* out
Declare PtrSafe Function WSManGetSessionOptionAsString Lib "wsmsvc" ( _
    ByVal session As LongPtr, _
    ByVal option As Long, _
    ByVal stringLength As Long, _
    ByVal string As LongPtr, _
    ByRef stringLengthUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSManGetSessionOptionAsString = ctypes.windll.wsmsvc.WSManGetSessionOptionAsString
WSManGetSessionOptionAsString.restype = wintypes.DWORD
WSManGetSessionOptionAsString.argtypes = [
    ctypes.c_ssize_t,  # session : WSMAN_SESSION_HANDLE
    ctypes.c_int,  # option : WSManSessionOption
    wintypes.DWORD,  # stringLength : DWORD
    wintypes.LPWSTR,  # string : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # stringLengthUsed : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wsmsvc = windows.NewLazySystemDLL("WsmSvc.dll")
	procWSManGetSessionOptionAsString = wsmsvc.NewProc("WSManGetSessionOptionAsString")
)

// session (WSMAN_SESSION_HANDLE), option (WSManSessionOption), stringLength (DWORD), string (LPWSTR optional, out), stringLengthUsed (DWORD* out)
r1, _, err := procWSManGetSessionOptionAsString.Call(
	uintptr(session),
	uintptr(option),
	uintptr(stringLength),
	uintptr(string),
	uintptr(stringLengthUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WSManGetSessionOptionAsString(
  session: NativeInt;   // WSMAN_SESSION_HANDLE
  option: Integer;   // WSManSessionOption
  stringLength: DWORD;   // DWORD
  string: PWideChar;   // LPWSTR optional, out
  stringLengthUsed: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WsmSvc.dll' name 'WSManGetSessionOptionAsString';
result := DllCall("WsmSvc\WSManGetSessionOptionAsString"
    , "Ptr", session   ; WSMAN_SESSION_HANDLE
    , "Int", option   ; WSManSessionOption
    , "UInt", stringLength   ; DWORD
    , "Ptr", string   ; LPWSTR optional, out
    , "Ptr", stringLengthUsed   ; DWORD* out
    , "UInt")   ; return: DWORD
●WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed) = DLL("WsmSvc.dll", "dword WSManGetSessionOptionAsString(int, int, dword, char*, void*)")
# 呼び出し: WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed)
# session : WSMAN_SESSION_HANDLE -> "int"
# option : WSManSessionOption -> "int"
# stringLength : DWORD -> "dword"
# string : LPWSTR optional, out -> "char*"
# stringLengthUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。