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

RasGetErrorStringA

関数
RASエラーコードに対応するエラーメッセージ文字列を取得する(ANSI版)。
DLLRASAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RASAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD RasGetErrorStringA(
    DWORD ResourceId,
    LPSTR lpszString,
    DWORD InBufSize
);

パラメーター

名前方向説明
ResourceIdDWORDinメッセージを取得するRAS固有のエラーコード値。
lpszStringLPSTRoutエラーメッセージ文字列を受け取るANSIバッファへのポインタ。
InBufSizeDWORDinlpszStringが指すバッファの文字数。

戻り値の型: DWORD

各言語での呼び出し定義

// RASAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD RasGetErrorStringA(
    DWORD ResourceId,
    LPSTR lpszString,
    DWORD InBufSize
);
[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RasGetErrorStringA(
    uint ResourceId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszString,   // LPSTR out
    uint InBufSize   // DWORD
);
<DllImport("RASAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasGetErrorStringA(
    ResourceId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszString As System.Text.StringBuilder,   ' LPSTR out
    InBufSize As UInteger   ' DWORD
) As UInteger
End Function
' ResourceId : DWORD
' lpszString : LPSTR out
' InBufSize : DWORD
Declare PtrSafe Function RasGetErrorStringA Lib "rasapi32" ( _
    ByVal ResourceId As Long, _
    ByVal lpszString As String, _
    ByVal InBufSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RasGetErrorStringA = ctypes.windll.rasapi32.RasGetErrorStringA
RasGetErrorStringA.restype = wintypes.DWORD
RasGetErrorStringA.argtypes = [
    wintypes.DWORD,  # ResourceId : DWORD
    wintypes.LPSTR,  # lpszString : LPSTR out
    wintypes.DWORD,  # InBufSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rasapi32 = windows.NewLazySystemDLL("RASAPI32.dll")
	procRasGetErrorStringA = rasapi32.NewProc("RasGetErrorStringA")
)

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

extern "rasapi32" fn RasGetErrorStringA(
    ResourceId: u32, // DWORD
    lpszString: [*c]u8, // LPSTR out
    InBufSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc RasGetErrorStringA(
    ResourceId: uint32,  # DWORD
    lpszString: ptr char,  # LPSTR out
    InBufSize: uint32  # DWORD
): uint32 {.importc: "RasGetErrorStringA", stdcall, dynlib: "RASAPI32.dll".}
pragma(lib, "rasapi32");
extern(Windows)
uint RasGetErrorStringA(
    uint ResourceId,   // DWORD
    char* lpszString,   // LPSTR out
    uint InBufSize   // DWORD
);
ccall((:RasGetErrorStringA, "RASAPI32.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt8}, UInt32),
      ResourceId, lpszString, InBufSize)
# ResourceId : DWORD -> UInt32
# lpszString : LPSTR out -> Ptr{UInt8}
# InBufSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RasGetErrorStringA(
    uint32_t ResourceId,
    char* lpszString,
    uint32_t InBufSize);
]]
local rasapi32 = ffi.load("rasapi32")
-- rasapi32.RasGetErrorStringA(ResourceId, lpszString, InBufSize)
-- ResourceId : DWORD
-- lpszString : LPSTR out
-- InBufSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RASAPI32.dll');
const RasGetErrorStringA = lib.func('__stdcall', 'RasGetErrorStringA', 'uint32_t', ['uint32_t', 'char *', 'uint32_t']);
// RasGetErrorStringA(ResourceId, lpszString, InBufSize)
// ResourceId : DWORD -> 'uint32_t'
// lpszString : LPSTR out -> 'char *'
// InBufSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RASAPI32.dll", {
  RasGetErrorStringA: { parameters: ["u32", "buffer", "u32"], result: "u32" },
});
// lib.symbols.RasGetErrorStringA(ResourceId, lpszString, InBufSize)
// ResourceId : DWORD -> "u32"
// lpszString : LPSTR out -> "buffer"
// InBufSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RasGetErrorStringA(
    uint32_t ResourceId,
    char* lpszString,
    uint32_t InBufSize);
C, "RASAPI32.dll");
// $ffi->RasGetErrorStringA(ResourceId, lpszString, InBufSize);
// ResourceId : DWORD
// lpszString : LPSTR out
// InBufSize : DWORD
// 構造体/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 Rasapi32 extends StdCallLibrary {
    Rasapi32 INSTANCE = Native.load("rasapi32", Rasapi32.class, W32APIOptions.ASCII_OPTIONS);
    int RasGetErrorStringA(
        int ResourceId,   // DWORD
        byte[] lpszString,   // LPSTR out
        int InBufSize   // DWORD
    );
}
@[Link("rasapi32")]
lib LibRASAPI32
  fun RasGetErrorStringA = RasGetErrorStringA(
    ResourceId : UInt32,   # DWORD
    lpszString : UInt8*,   # LPSTR out
    InBufSize : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RasGetErrorStringANative = Uint32 Function(Uint32, Pointer<Utf8>, Uint32);
typedef RasGetErrorStringADart = int Function(int, Pointer<Utf8>, int);
final RasGetErrorStringA = DynamicLibrary.open('RASAPI32.dll')
    .lookupFunction<RasGetErrorStringANative, RasGetErrorStringADart>('RasGetErrorStringA');
// ResourceId : DWORD -> Uint32
// lpszString : LPSTR out -> Pointer<Utf8>
// InBufSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RasGetErrorStringA(
  ResourceId: DWORD;   // DWORD
  lpszString: PAnsiChar;   // LPSTR out
  InBufSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasGetErrorStringA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RasGetErrorStringA"
  c_RasGetErrorStringA :: Word32 -> CString -> Word32 -> IO Word32
-- ResourceId : DWORD -> Word32
-- lpszString : LPSTR out -> CString
-- InBufSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rasgeterrorstringa =
  foreign "RasGetErrorStringA"
    (uint32_t @-> string @-> uint32_t @-> returning uint32_t)
(* ResourceId : DWORD -> uint32_t *)
(* lpszString : LPSTR out -> string *)
(* InBufSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rasapi32 (t "RASAPI32.dll"))
(cffi:use-foreign-library rasapi32)

(cffi:defcfun ("RasGetErrorStringA" ras-get-error-string-a :convention :stdcall) :uint32
  (resource-id :uint32)   ; DWORD
  (lpsz-string :pointer)   ; LPSTR out
  (in-buf-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RasGetErrorStringA = Win32::API::More->new('RASAPI32',
    'DWORD RasGetErrorStringA(DWORD ResourceId, LPSTR lpszString, DWORD InBufSize)');
# my $ret = $RasGetErrorStringA->Call($ResourceId, $lpszString, $InBufSize);
# ResourceId : DWORD -> DWORD
# lpszString : LPSTR out -> LPSTR
# InBufSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い