ホーム › System.RemoteManagement › WSManGetErrorMessage

WSManGetErrorMessage

関数

エラーコードに対応する説明メッセージを取得する。

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

シグネチャ

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

DWORD WSManGetErrorMessage(
    WSMAN_API_HANDLE apiHandle,
    DWORD flags,   // optional
    LPCWSTR languageCode,   // optional
    DWORD errorCode,
    DWORD messageLength,
    LPWSTR message,   // optional
    DWORD* messageLengthUsed
);

パラメーター

名前	型	方向
apiHandle	WSMAN_API_HANDLE	in
flags	DWORD	optional
languageCode	LPCWSTR	inoptional
errorCode	DWORD	in
messageLength	DWORD	in
message	LPWSTR	outoptional
messageLengthUsed	DWORD*	out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WSManGetErrorMessage(
    WSMAN_API_HANDLE apiHandle,
    DWORD flags,   // optional
    LPCWSTR languageCode,   // optional
    DWORD errorCode,
    DWORD messageLength,
    LPWSTR message,   // optional
    DWORD* messageLengthUsed
);

[DllImport("WsmSvc.dll", ExactSpelling = true)]
static extern uint WSManGetErrorMessage(
    IntPtr apiHandle,   // WSMAN_API_HANDLE
    uint flags,   // DWORD optional
    [MarshalAs(UnmanagedType.LPWStr)] string languageCode,   // LPCWSTR optional
    uint errorCode,   // DWORD
    uint messageLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder message,   // LPWSTR optional, out
    out uint messageLengthUsed   // DWORD* out
);

<DllImport("WsmSvc.dll", ExactSpelling:=True)>
Public Shared Function WSManGetErrorMessage(
    apiHandle As IntPtr,   ' WSMAN_API_HANDLE
    flags As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPWStr)> languageCode As String,   ' LPCWSTR optional
    errorCode As UInteger,   ' DWORD
    messageLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> message As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef messageLengthUsed As UInteger   ' DWORD* out
) As UInteger
End Function

' apiHandle : WSMAN_API_HANDLE
' flags : DWORD optional
' languageCode : LPCWSTR optional
' errorCode : DWORD
' messageLength : DWORD
' message : LPWSTR optional, out
' messageLengthUsed : DWORD* out
Declare PtrSafe Function WSManGetErrorMessage Lib "wsmsvc" ( _
    ByVal apiHandle As LongPtr, _
    ByVal flags As Long, _
    ByVal languageCode As LongPtr, _
    ByVal errorCode As Long, _
    ByVal messageLength As Long, _
    ByVal message As LongPtr, _
    ByRef messageLengthUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSManGetErrorMessage = ctypes.windll.wsmsvc.WSManGetErrorMessage
WSManGetErrorMessage.restype = wintypes.DWORD
WSManGetErrorMessage.argtypes = [
    ctypes.c_ssize_t,  # apiHandle : WSMAN_API_HANDLE
    wintypes.DWORD,  # flags : DWORD optional
    wintypes.LPCWSTR,  # languageCode : LPCWSTR optional
    wintypes.DWORD,  # errorCode : DWORD
    wintypes.DWORD,  # messageLength : DWORD
    wintypes.LPWSTR,  # message : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # messageLengthUsed : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WsmSvc.dll')
WSManGetErrorMessage = Fiddle::Function.new(
  lib['WSManGetErrorMessage'],
  [
    Fiddle::TYPE_INTPTR_T,  # apiHandle : WSMAN_API_HANDLE
    -Fiddle::TYPE_INT,  # flags : DWORD optional
    Fiddle::TYPE_VOIDP,  # languageCode : LPCWSTR optional
    -Fiddle::TYPE_INT,  # errorCode : DWORD
    -Fiddle::TYPE_INT,  # messageLength : DWORD
    Fiddle::TYPE_VOIDP,  # message : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # messageLengthUsed : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wsmsvc")]
extern "system" {
    fn WSManGetErrorMessage(
        apiHandle: isize,  // WSMAN_API_HANDLE
        flags: u32,  // DWORD optional
        languageCode: *const u16,  // LPCWSTR optional
        errorCode: u32,  // DWORD
        messageLength: u32,  // DWORD
        message: *mut u16,  // LPWSTR optional, out
        messageLengthUsed: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WsmSvc.dll")]
public static extern uint WSManGetErrorMessage(IntPtr apiHandle, uint flags, [MarshalAs(UnmanagedType.LPWStr)] string languageCode, uint errorCode, uint messageLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder message, out uint messageLengthUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WsmSvc_WSManGetErrorMessage' -Namespace Win32 -PassThru
# $api::WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)

#uselib "WsmSvc.dll"
#func global WSManGetErrorMessage "WSManGetErrorMessage" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WSManGetErrorMessage apiHandle, flags, languageCode, errorCode, messageLength, varptr(message), varptr(messageLengthUsed)   ; 戻り値は stat
; apiHandle : WSMAN_API_HANDLE -> "sptr"
; flags : DWORD optional -> "sptr"
; languageCode : LPCWSTR optional -> "sptr"
; errorCode : DWORD -> "sptr"
; messageLength : DWORD -> "sptr"
; message : LPWSTR optional, out -> "sptr"
; messageLengthUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WsmSvc.dll"
#cfunc global WSManGetErrorMessage "WSManGetErrorMessage" sptr, int, wstr, int, int, var, var
; res = WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
; apiHandle : WSMAN_API_HANDLE -> "sptr"
; flags : DWORD optional -> "int"
; languageCode : LPCWSTR optional -> "wstr"
; errorCode : DWORD -> "int"
; messageLength : DWORD -> "int"
; message : LPWSTR optional, out -> "var"
; messageLengthUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WsmSvc.dll"
#cfunc global WSManGetErrorMessage "WSManGetErrorMessage" sptr, int, wstr, int, int, sptr, sptr
; res = WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, varptr(message), varptr(messageLengthUsed))
; apiHandle : WSMAN_API_HANDLE -> "sptr"
; flags : DWORD optional -> "int"
; languageCode : LPCWSTR optional -> "wstr"
; errorCode : DWORD -> "int"
; messageLength : DWORD -> "int"
; message : LPWSTR optional, out -> "sptr"
; messageLengthUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD WSManGetErrorMessage(WSMAN_API_HANDLE apiHandle, DWORD flags, LPCWSTR languageCode, DWORD errorCode, DWORD messageLength, LPWSTR message, DWORD* messageLengthUsed)
#uselib "WsmSvc.dll"
#cfunc global WSManGetErrorMessage "WSManGetErrorMessage" intptr, int, wstr, int, int, var, var
; res = WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
; apiHandle : WSMAN_API_HANDLE -> "intptr"
; flags : DWORD optional -> "int"
; languageCode : LPCWSTR optional -> "wstr"
; errorCode : DWORD -> "int"
; messageLength : DWORD -> "int"
; message : LPWSTR optional, out -> "var"
; messageLengthUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD WSManGetErrorMessage(WSMAN_API_HANDLE apiHandle, DWORD flags, LPCWSTR languageCode, DWORD errorCode, DWORD messageLength, LPWSTR message, DWORD* messageLengthUsed)
#uselib "WsmSvc.dll"
#cfunc global WSManGetErrorMessage "WSManGetErrorMessage" intptr, int, wstr, int, int, intptr, intptr
; res = WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, varptr(message), varptr(messageLengthUsed))
; apiHandle : WSMAN_API_HANDLE -> "intptr"
; flags : DWORD optional -> "int"
; languageCode : LPCWSTR optional -> "wstr"
; errorCode : DWORD -> "int"
; messageLength : DWORD -> "int"
; message : LPWSTR optional, out -> "intptr"
; messageLengthUsed : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	wsmsvc = windows.NewLazySystemDLL("WsmSvc.dll")
	procWSManGetErrorMessage = wsmsvc.NewProc("WSManGetErrorMessage")
)

// apiHandle (WSMAN_API_HANDLE), flags (DWORD optional), languageCode (LPCWSTR optional), errorCode (DWORD), messageLength (DWORD), message (LPWSTR optional, out), messageLengthUsed (DWORD* out)
r1, _, err := procWSManGetErrorMessage.Call(
	uintptr(apiHandle),
	uintptr(flags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(languageCode))),
	uintptr(errorCode),
	uintptr(messageLength),
	uintptr(message),
	uintptr(messageLengthUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function WSManGetErrorMessage(
  apiHandle: NativeInt;   // WSMAN_API_HANDLE
  flags: DWORD;   // DWORD optional
  languageCode: PWideChar;   // LPCWSTR optional
  errorCode: DWORD;   // DWORD
  messageLength: DWORD;   // DWORD
  message: PWideChar;   // LPWSTR optional, out
  messageLengthUsed: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WsmSvc.dll' name 'WSManGetErrorMessage';

result := DllCall("WsmSvc\WSManGetErrorMessage"
    , "Ptr", apiHandle   ; WSMAN_API_HANDLE
    , "UInt", flags   ; DWORD optional
    , "WStr", languageCode   ; LPCWSTR optional
    , "UInt", errorCode   ; DWORD
    , "UInt", messageLength   ; DWORD
    , "Ptr", message   ; LPWSTR optional, out
    , "Ptr", messageLengthUsed   ; DWORD* out
    , "UInt")   ; return: DWORD

●WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed) = DLL("WsmSvc.dll", "dword WSManGetErrorMessage(int, dword, char*, dword, dword, char*, void*)")
# 呼び出し: WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
# apiHandle : WSMAN_API_HANDLE -> "int"
# flags : DWORD optional -> "dword"
# languageCode : LPCWSTR optional -> "char*"
# errorCode : DWORD -> "dword"
# messageLength : DWORD -> "dword"
# message : LPWSTR optional, out -> "char*"
# messageLengthUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。