Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
apiHandleWSMAN_API_HANDLEinWSManInitialize で取得したAPIハンドル。
flagsDWORDoptional動作を制御するフラグ。通常は 0 を指定する。
languageCodeLPCWSTRinoptionalメッセージの言語を示すRFC3066言語コード文字列。NULL でシステム既定を使う。
errorCodeDWORDinメッセージを取得する対象のエラーコード。
messageLengthDWORDinmessage バッファーの文字数。
messageLPWSTRoutoptional取得したエラーメッセージ文字列を受け取るバッファー。
messageLengthUsedDWORD*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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "wsmsvc" fn WSManGetErrorMessage(
    apiHandle: isize, // WSMAN_API_HANDLE
    flags: u32, // DWORD optional
    languageCode: [*c]const u16, // LPCWSTR optional
    errorCode: u32, // DWORD
    messageLength: u32, // DWORD
    message: [*c]u16, // LPWSTR optional, out
    messageLengthUsed: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc WSManGetErrorMessage(
    apiHandle: int,  # WSMAN_API_HANDLE
    flags: uint32,  # DWORD optional
    languageCode: WideCString,  # LPCWSTR optional
    errorCode: uint32,  # DWORD
    messageLength: uint32,  # DWORD
    message: ptr uint16,  # LPWSTR optional, out
    messageLengthUsed: ptr uint32  # DWORD* out
): uint32 {.importc: "WSManGetErrorMessage", stdcall, dynlib: "WsmSvc.dll".}
pragma(lib, "wsmsvc");
extern(Windows)
uint WSManGetErrorMessage(
    ptrdiff_t apiHandle,   // WSMAN_API_HANDLE
    uint flags,   // DWORD optional
    const(wchar)* languageCode,   // LPCWSTR optional
    uint errorCode,   // DWORD
    uint messageLength,   // DWORD
    wchar* message,   // LPWSTR optional, out
    uint* messageLengthUsed   // DWORD* out
);
ccall((:WSManGetErrorMessage, "WsmSvc.dll"), stdcall, UInt32,
      (Int, UInt32, Cwstring, UInt32, UInt32, Ptr{UInt16}, Ptr{UInt32}),
      apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
# apiHandle : WSMAN_API_HANDLE -> Int
# flags : DWORD optional -> UInt32
# languageCode : LPCWSTR optional -> Cwstring
# errorCode : DWORD -> UInt32
# messageLength : DWORD -> UInt32
# message : LPWSTR optional, out -> Ptr{UInt16}
# messageLengthUsed : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WSManGetErrorMessage(
    intptr_t apiHandle,
    uint32_t flags,
    const uint16_t* languageCode,
    uint32_t errorCode,
    uint32_t messageLength,
    uint16_t* message,
    uint32_t* messageLengthUsed);
]]
local wsmsvc = ffi.load("wsmsvc")
-- wsmsvc.WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
-- apiHandle : WSMAN_API_HANDLE
-- flags : DWORD optional
-- languageCode : LPCWSTR optional
-- errorCode : DWORD
-- messageLength : DWORD
-- message : LPWSTR optional, out
-- messageLengthUsed : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WsmSvc.dll');
const WSManGetErrorMessage = lib.func('__stdcall', 'WSManGetErrorMessage', 'uint32_t', ['intptr_t', 'uint32_t', 'str16', 'uint32_t', 'uint32_t', 'uint16_t *', 'uint32_t *']);
// WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
// apiHandle : WSMAN_API_HANDLE -> 'intptr_t'
// flags : DWORD optional -> 'uint32_t'
// languageCode : LPCWSTR optional -> 'str16'
// errorCode : DWORD -> 'uint32_t'
// messageLength : DWORD -> 'uint32_t'
// message : LPWSTR optional, out -> 'uint16_t *'
// messageLengthUsed : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WsmSvc.dll", {
  WSManGetErrorMessage: { parameters: ["isize", "u32", "buffer", "u32", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed)
// apiHandle : WSMAN_API_HANDLE -> "isize"
// flags : DWORD optional -> "u32"
// languageCode : LPCWSTR optional -> "buffer"
// errorCode : DWORD -> "u32"
// messageLength : DWORD -> "u32"
// message : LPWSTR optional, out -> "buffer"
// messageLengthUsed : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WSManGetErrorMessage(
    intptr_t apiHandle,
    uint32_t flags,
    const uint16_t* languageCode,
    uint32_t errorCode,
    uint32_t messageLength,
    uint16_t* message,
    uint32_t* messageLengthUsed);
C, "WsmSvc.dll");
// $ffi->WSManGetErrorMessage(apiHandle, flags, languageCode, errorCode, messageLength, message, messageLengthUsed);
// apiHandle : WSMAN_API_HANDLE
// flags : DWORD optional
// languageCode : LPCWSTR optional
// errorCode : DWORD
// messageLength : DWORD
// message : LPWSTR optional, out
// messageLengthUsed : 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 WSManGetErrorMessage(
        long apiHandle,   // WSMAN_API_HANDLE
        int flags,   // DWORD optional
        WString languageCode,   // LPCWSTR optional
        int errorCode,   // DWORD
        int messageLength,   // DWORD
        char[] message,   // LPWSTR optional, out
        IntByReference messageLengthUsed   // DWORD* out
    );
}
@[Link("wsmsvc")]
lib LibWsmSvc
  fun WSManGetErrorMessage = WSManGetErrorMessage(
    apiHandle : LibC::SSizeT,   # WSMAN_API_HANDLE
    flags : UInt32,   # DWORD optional
    languageCode : UInt16*,   # LPCWSTR optional
    errorCode : UInt32,   # DWORD
    messageLength : UInt32,   # DWORD
    message : UInt16*,   # LPWSTR optional, out
    messageLengthUsed : 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 WSManGetErrorMessageNative = Uint32 Function(IntPtr, Uint32, Pointer<Utf16>, Uint32, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef WSManGetErrorMessageDart = int Function(int, int, Pointer<Utf16>, int, int, Pointer<Utf16>, Pointer<Uint32>);
final WSManGetErrorMessage = DynamicLibrary.open('WsmSvc.dll')
    .lookupFunction<WSManGetErrorMessageNative, WSManGetErrorMessageDart>('WSManGetErrorMessage');
// apiHandle : WSMAN_API_HANDLE -> IntPtr
// flags : DWORD optional -> Uint32
// languageCode : LPCWSTR optional -> Pointer<Utf16>
// errorCode : DWORD -> Uint32
// messageLength : DWORD -> Uint32
// message : LPWSTR optional, out -> Pointer<Utf16>
// messageLengthUsed : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSManGetErrorMessage"
  c_WSManGetErrorMessage :: CIntPtr -> Word32 -> CWString -> Word32 -> Word32 -> CWString -> Ptr Word32 -> IO Word32
-- apiHandle : WSMAN_API_HANDLE -> CIntPtr
-- flags : DWORD optional -> Word32
-- languageCode : LPCWSTR optional -> CWString
-- errorCode : DWORD -> Word32
-- messageLength : DWORD -> Word32
-- message : LPWSTR optional, out -> CWString
-- messageLengthUsed : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsmangeterrormessage =
  foreign "WSManGetErrorMessage"
    (intptr_t @-> uint32_t @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* apiHandle : WSMAN_API_HANDLE -> intptr_t *)
(* flags : DWORD optional -> uint32_t *)
(* languageCode : LPCWSTR optional -> (ptr uint16_t) *)
(* errorCode : DWORD -> uint32_t *)
(* messageLength : DWORD -> uint32_t *)
(* message : LPWSTR optional, out -> (ptr uint16_t) *)
(* messageLengthUsed : 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 ("WSManGetErrorMessage" wsman-get-error-message :convention :stdcall) :uint32
  (api-handle :int64)   ; WSMAN_API_HANDLE
  (flags :uint32)   ; DWORD optional
  (language-code (:string :encoding :utf-16le))   ; LPCWSTR optional
  (error-code :uint32)   ; DWORD
  (message-length :uint32)   ; DWORD
  (message :pointer)   ; LPWSTR optional, out
  (message-length-used :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSManGetErrorMessage = Win32::API::More->new('WsmSvc',
    'DWORD WSManGetErrorMessage(LPARAM apiHandle, DWORD flags, LPCWSTR languageCode, DWORD errorCode, DWORD messageLength, LPWSTR message, LPVOID messageLengthUsed)');
# my $ret = $WSManGetErrorMessage->Call($apiHandle, $flags, $languageCode, $errorCode, $messageLength, $message, $messageLengthUsed);
# apiHandle : WSMAN_API_HANDLE -> LPARAM
# flags : DWORD optional -> DWORD
# languageCode : LPCWSTR optional -> LPCWSTR
# errorCode : DWORD -> DWORD
# messageLength : DWORD -> DWORD
# message : LPWSTR optional, out -> LPWSTR
# messageLengthUsed : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。