Win32 API 日本語リファレンス
ホームNetworkManagement.Rras › MprAdminGetErrorString

MprAdminGetErrorString

関数
ルーター管理のエラーコードを説明文字列に変換する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MprAdminGetErrorString(
    DWORD dwError,
    LPWSTR* lplpwsErrorString
);

パラメーター

名前方向説明
dwErrorDWORDinメッセージ文字列を取得する対象のRRAS固有エラーコード。
lplpwsErrorStringLPWSTR*out確保されたエラー説明文字列へのポインタを受け取る変数。LocalFreeで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MprAdminGetErrorString(
    DWORD dwError,
    LPWSTR* lplpwsErrorString
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprAdminGetErrorString(
    uint dwError,   // DWORD
    IntPtr lplpwsErrorString   // LPWSTR* out
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprAdminGetErrorString(
    dwError As UInteger,   ' DWORD
    lplpwsErrorString As IntPtr   ' LPWSTR* out
) As UInteger
End Function
' dwError : DWORD
' lplpwsErrorString : LPWSTR* out
Declare PtrSafe Function MprAdminGetErrorString Lib "mprapi" ( _
    ByVal dwError As Long, _
    ByVal lplpwsErrorString As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MprAdminGetErrorString = ctypes.windll.mprapi.MprAdminGetErrorString
MprAdminGetErrorString.restype = wintypes.DWORD
MprAdminGetErrorString.argtypes = [
    wintypes.DWORD,  # dwError : DWORD
    ctypes.c_void_p,  # lplpwsErrorString : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminGetErrorString = mprapi.NewProc("MprAdminGetErrorString")
)

// dwError (DWORD), lplpwsErrorString (LPWSTR* out)
r1, _, err := procMprAdminGetErrorString.Call(
	uintptr(dwError),
	uintptr(lplpwsErrorString),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MprAdminGetErrorString(
  dwError: DWORD;   // DWORD
  lplpwsErrorString: PPWideChar   // LPWSTR* out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminGetErrorString';
result := DllCall("MPRAPI\MprAdminGetErrorString"
    , "UInt", dwError   ; DWORD
    , "Ptr", lplpwsErrorString   ; LPWSTR* out
    , "UInt")   ; return: DWORD
●MprAdminGetErrorString(dwError, lplpwsErrorString) = DLL("MPRAPI.dll", "dword MprAdminGetErrorString(dword, void*)")
# 呼び出し: MprAdminGetErrorString(dwError, lplpwsErrorString)
# dwError : DWORD -> "dword"
# lplpwsErrorString : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MprAdminGetErrorStringNative = Uint32 Function(Uint32, Pointer<Pointer<Utf16>>);
typedef MprAdminGetErrorStringDart = int Function(int, Pointer<Pointer<Utf16>>);
final MprAdminGetErrorString = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminGetErrorStringNative, MprAdminGetErrorStringDart>('MprAdminGetErrorString');
// dwError : DWORD -> Uint32
// lplpwsErrorString : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminGetErrorString(
  dwError: DWORD;   // DWORD
  lplpwsErrorString: PPWideChar   // LPWSTR* out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminGetErrorString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminGetErrorString"
  c_MprAdminGetErrorString :: Word32 -> Ptr CWString -> IO Word32
-- dwError : DWORD -> Word32
-- lplpwsErrorString : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradmingeterrorstring =
  foreign "MprAdminGetErrorString"
    (uint32_t @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* dwError : DWORD -> uint32_t *)
(* lplpwsErrorString : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminGetErrorString" mpr-admin-get-error-string :convention :stdcall) :uint32
  (dw-error :uint32)   ; DWORD
  (lplpws-error-string :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminGetErrorString = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminGetErrorString(DWORD dwError, LPVOID lplpwsErrorString)');
# my $ret = $MprAdminGetErrorString->Call($dwError, $lplpwsErrorString);
# dwError : DWORD -> DWORD
# lplpwsErrorString : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。