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取得するセッションオプションを示す WSManSessionOption 列挙値。
stringLengthDWORDinstring バッファーの文字数。
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)。
const std = @import("std");

extern "wsmsvc" fn WSManGetSessionOptionAsString(
    session: isize, // WSMAN_SESSION_HANDLE
    option: i32, // WSManSessionOption
    stringLength: u32, // DWORD
    string: [*c]u16, // LPWSTR optional, out
    stringLengthUsed: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc WSManGetSessionOptionAsString(
    session: int,  # WSMAN_SESSION_HANDLE
    option: int32,  # WSManSessionOption
    stringLength: uint32,  # DWORD
    string: ptr uint16,  # LPWSTR optional, out
    stringLengthUsed: ptr uint32  # DWORD* out
): uint32 {.importc: "WSManGetSessionOptionAsString", stdcall, dynlib: "WsmSvc.dll".}
pragma(lib, "wsmsvc");
extern(Windows)
uint WSManGetSessionOptionAsString(
    ptrdiff_t session,   // WSMAN_SESSION_HANDLE
    int option,   // WSManSessionOption
    uint stringLength,   // DWORD
    wchar* string,   // LPWSTR optional, out
    uint* stringLengthUsed   // DWORD* out
);
ccall((:WSManGetSessionOptionAsString, "WsmSvc.dll"), stdcall, UInt32,
      (Int, Int32, UInt32, Ptr{UInt16}, Ptr{UInt32}),
      session, option, stringLength, string, stringLengthUsed)
# session : WSMAN_SESSION_HANDLE -> Int
# option : WSManSessionOption -> Int32
# stringLength : DWORD -> UInt32
# string : LPWSTR optional, out -> Ptr{UInt16}
# stringLengthUsed : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WSManGetSessionOptionAsString(
    intptr_t session,
    int32_t option,
    uint32_t stringLength,
    uint16_t* string,
    uint32_t* stringLengthUsed);
]]
local wsmsvc = ffi.load("wsmsvc")
-- wsmsvc.WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed)
-- session : WSMAN_SESSION_HANDLE
-- option : WSManSessionOption
-- stringLength : DWORD
-- string : LPWSTR optional, out
-- stringLengthUsed : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WsmSvc.dll');
const WSManGetSessionOptionAsString = lib.func('__stdcall', 'WSManGetSessionOptionAsString', 'uint32_t', ['intptr_t', 'int32_t', 'uint32_t', 'uint16_t *', 'uint32_t *']);
// WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed)
// session : WSMAN_SESSION_HANDLE -> 'intptr_t'
// option : WSManSessionOption -> 'int32_t'
// stringLength : DWORD -> 'uint32_t'
// string : LPWSTR optional, out -> 'uint16_t *'
// stringLengthUsed : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WsmSvc.dll", {
  WSManGetSessionOptionAsString: { parameters: ["isize", "i32", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed)
// session : WSMAN_SESSION_HANDLE -> "isize"
// option : WSManSessionOption -> "i32"
// stringLength : DWORD -> "u32"
// string : LPWSTR optional, out -> "buffer"
// stringLengthUsed : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WSManGetSessionOptionAsString(
    intptr_t session,
    int32_t option,
    uint32_t stringLength,
    uint16_t* string,
    uint32_t* stringLengthUsed);
C, "WsmSvc.dll");
// $ffi->WSManGetSessionOptionAsString(session, option, stringLength, string, stringLengthUsed);
// session : WSMAN_SESSION_HANDLE
// option : WSManSessionOption
// stringLength : DWORD
// string : LPWSTR optional, out
// stringLengthUsed : DWORD* out
// 構造体/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 WSManGetSessionOptionAsString(
        long session,   // WSMAN_SESSION_HANDLE
        int option,   // WSManSessionOption
        int stringLength,   // DWORD
        char[] string,   // LPWSTR optional, out
        IntByReference stringLengthUsed   // DWORD* out
    );
}
@[Link("wsmsvc")]
lib LibWsmSvc
  fun WSManGetSessionOptionAsString = WSManGetSessionOptionAsString(
    session : LibC::SSizeT,   # WSMAN_SESSION_HANDLE
    option : Int32,   # WSManSessionOption
    stringLength : UInt32,   # DWORD
    string : UInt16*,   # LPWSTR optional, out
    stringLengthUsed : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSManGetSessionOptionAsStringNative = Uint32 Function(IntPtr, Int32, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef WSManGetSessionOptionAsStringDart = int Function(int, int, int, Pointer<Utf16>, Pointer<Uint32>);
final WSManGetSessionOptionAsString = DynamicLibrary.open('WsmSvc.dll')
    .lookupFunction<WSManGetSessionOptionAsStringNative, WSManGetSessionOptionAsStringDart>('WSManGetSessionOptionAsString');
// session : WSMAN_SESSION_HANDLE -> IntPtr
// option : WSManSessionOption -> Int32
// stringLength : DWORD -> Uint32
// string : LPWSTR optional, out -> Pointer<Utf16>
// stringLengthUsed : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSManGetSessionOptionAsString"
  c_WSManGetSessionOptionAsString :: CIntPtr -> Int32 -> Word32 -> CWString -> Ptr Word32 -> IO Word32
-- session : WSMAN_SESSION_HANDLE -> CIntPtr
-- option : WSManSessionOption -> Int32
-- stringLength : DWORD -> Word32
-- string : LPWSTR optional, out -> CWString
-- stringLengthUsed : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsmangetsessionoptionasstring =
  foreign "WSManGetSessionOptionAsString"
    (intptr_t @-> int32_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* session : WSMAN_SESSION_HANDLE -> intptr_t *)
(* option : WSManSessionOption -> int32_t *)
(* stringLength : DWORD -> uint32_t *)
(* string : LPWSTR optional, out -> (ptr uint16_t) *)
(* stringLengthUsed : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsmsvc (t "WsmSvc.dll"))
(cffi:use-foreign-library wsmsvc)

(cffi:defcfun ("WSManGetSessionOptionAsString" wsman-get-session-option-as-string :convention :stdcall) :uint32
  (session :int64)   ; WSMAN_SESSION_HANDLE
  (option :int32)   ; WSManSessionOption
  (string-length :uint32)   ; DWORD
  (string :pointer)   ; LPWSTR optional, out
  (string-length-used :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSManGetSessionOptionAsString = Win32::API::More->new('WsmSvc',
    'DWORD WSManGetSessionOptionAsString(LPARAM session, int option, DWORD stringLength, LPWSTR string, LPVOID stringLengthUsed)');
# my $ret = $WSManGetSessionOptionAsString->Call($session, $option, $stringLength, $string, $stringLengthUsed);
# session : WSMAN_SESSION_HANDLE -> LPARAM
# option : WSManSessionOption -> int
# stringLength : DWORD -> DWORD
# string : LPWSTR optional, out -> LPWSTR
# stringLengthUsed : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型