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

RasGetEntryPropertiesA

関数
RAS電話帳エントリのプロパティを取得する(ANSI版)。
DLLRASAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD RasGetEntryPropertiesA(
    LPCSTR param0,   // optional
    LPCSTR param1,
    RASENTRYA* param2,   // optional
    DWORD* param3,
    BYTE* param4,   // optional
    DWORD* param5   // optional
);

パラメーター

名前型方向説明
param0LPCSTRinoptional電話帳ファイルのフルパス文字列。NULL指定で既定の電話帳を使用する。
param1LPCSTRin対象エントリ名の文字列。空文字列指定で既定値テンプレートを取得する。
param2RASENTRYA*inoutoptionalエントリのプロパティを受け取るRASENTRYA構造体へのポインタ。dwSizeを事前設定する。
param3DWORD*inoutparam2バッファのサイズ(バイト)を保持する入出力変数へのポインタ。
param4BYTE*outoptionalデバイス固有の構成データを受け取るバッファへのポインタ。不要ならNULL可。
param5DWORD*inoutoptionalparam4バッファのサイズ(バイト)を保持する入出力変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RasGetEntryPropertiesA(
    LPCSTR param0,   // optional
    LPCSTR param1,
    RASENTRYA* param2,   // optional
    DWORD* param3,
    BYTE* param4,   // optional
    DWORD* param5   // optional
);
[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RasGetEntryPropertiesA(
    [MarshalAs(UnmanagedType.LPStr)] string param0,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string param1,   // LPCSTR
    IntPtr param2,   // RASENTRYA* optional, in/out
    ref uint param3,   // DWORD* in/out
    IntPtr param4,   // BYTE* optional, out
    IntPtr param5   // DWORD* optional, in/out
);
<DllImport("RASAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasGetEntryPropertiesA(
    <MarshalAs(UnmanagedType.LPStr)> param0 As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> param1 As String,   ' LPCSTR
    param2 As IntPtr,   ' RASENTRYA* optional, in/out
    ByRef param3 As UInteger,   ' DWORD* in/out
    param4 As IntPtr,   ' BYTE* optional, out
    param5 As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' param0 : LPCSTR optional
' param1 : LPCSTR
' param2 : RASENTRYA* optional, in/out
' param3 : DWORD* in/out
' param4 : BYTE* optional, out
' param5 : DWORD* optional, in/out
Declare PtrSafe Function RasGetEntryPropertiesA Lib "rasapi32" ( _
    ByVal param0 As String, _
    ByVal param1 As String, _
    ByVal param2 As LongPtr, _
    ByRef param3 As Long, _
    ByVal param4 As LongPtr, _
    ByVal param5 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RasGetEntryPropertiesA = ctypes.windll.rasapi32.RasGetEntryPropertiesA
RasGetEntryPropertiesA.restype = wintypes.DWORD
RasGetEntryPropertiesA.argtypes = [
    wintypes.LPCSTR,  # param0 : LPCSTR optional
    wintypes.LPCSTR,  # param1 : LPCSTR
    ctypes.c_void_p,  # param2 : RASENTRYA* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # param3 : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # param4 : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # param5 : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rasapi32 = windows.NewLazySystemDLL("RASAPI32.dll")
	procRasGetEntryPropertiesA = rasapi32.NewProc("RasGetEntryPropertiesA")
)

// param0 (LPCSTR optional), param1 (LPCSTR), param2 (RASENTRYA* optional, in/out), param3 (DWORD* in/out), param4 (BYTE* optional, out), param5 (DWORD* optional, in/out)
r1, _, err := procRasGetEntryPropertiesA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(param0))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(param1))),
	uintptr(param2),
	uintptr(param3),
	uintptr(param4),
	uintptr(param5),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function RasGetEntryPropertiesA(
  param0: PAnsiChar;   // LPCSTR optional
  param1: PAnsiChar;   // LPCSTR
  param2: Pointer;   // RASENTRYA* optional, in/out
  param3: Pointer;   // DWORD* in/out
  param4: Pointer;   // BYTE* optional, out
  param5: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasGetEntryPropertiesA';
result := DllCall("RASAPI32\RasGetEntryPropertiesA"
    , "AStr", param0   ; LPCSTR optional
    , "AStr", param1   ; LPCSTR
    , "Ptr", param2   ; RASENTRYA* optional, in/out
    , "Ptr", param3   ; DWORD* in/out
    , "Ptr", param4   ; BYTE* optional, out
    , "Ptr", param5   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD
●RasGetEntryPropertiesA(param0, param1, param2, param3, param4, param5) = DLL("RASAPI32.dll", "dword RasGetEntryPropertiesA(char*, char*, void*, void*, void*, void*)")
# 呼び出し: RasGetEntryPropertiesA(param0, param1, param2, param3, param4, param5)
# param0 : LPCSTR optional -> "char*"
# param1 : LPCSTR -> "char*"
# param2 : RASENTRYA* optional, in/out -> "void*"
# param3 : DWORD* in/out -> "void*"
# param4 : BYTE* optional, out -> "void*"
# param5 : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RasGetEntryPropertiesANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
typedef RasGetEntryPropertiesADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
final RasGetEntryPropertiesA = DynamicLibrary.open('RASAPI32.dll')
    .lookupFunction<RasGetEntryPropertiesANative, RasGetEntryPropertiesADart>('RasGetEntryPropertiesA');
// param0 : LPCSTR optional -> Pointer<Utf8>
// param1 : LPCSTR -> Pointer<Utf8>
// param2 : RASENTRYA* optional, in/out -> Pointer<Void>
// param3 : DWORD* in/out -> Pointer<Uint32>
// param4 : BYTE* optional, out -> Pointer<Uint8>
// param5 : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RasGetEntryPropertiesA(
  param0: PAnsiChar;   // LPCSTR optional
  param1: PAnsiChar;   // LPCSTR
  param2: Pointer;   // RASENTRYA* optional, in/out
  param3: Pointer;   // DWORD* in/out
  param4: Pointer;   // BYTE* optional, out
  param5: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasGetEntryPropertiesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RasGetEntryPropertiesA"
  c_RasGetEntryPropertiesA :: CString -> CString -> Ptr () -> Ptr Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- param0 : LPCSTR optional -> CString
-- param1 : LPCSTR -> CString
-- param2 : RASENTRYA* optional, in/out -> Ptr ()
-- param3 : DWORD* in/out -> Ptr Word32
-- param4 : BYTE* optional, out -> Ptr Word8
-- param5 : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rasgetentrypropertiesa =
  foreign "RasGetEntryPropertiesA"
    (string @-> string @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* param0 : LPCSTR optional -> string *)
(* param1 : LPCSTR -> string *)
(* param2 : RASENTRYA* optional, in/out -> (ptr void) *)
(* param3 : DWORD* in/out -> (ptr uint32_t) *)
(* param4 : BYTE* optional, out -> (ptr uint8_t) *)
(* param5 : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rasapi32 (t "RASAPI32.dll"))
(cffi:use-foreign-library rasapi32)

(cffi:defcfun ("RasGetEntryPropertiesA" ras-get-entry-properties-a :convention :stdcall) :uint32
  (param0 :string)   ; LPCSTR optional
  (param1 :string)   ; LPCSTR
  (param2 :pointer)   ; RASENTRYA* optional, in/out
  (param3 :pointer)   ; DWORD* in/out
  (param4 :pointer)   ; BYTE* optional, out
  (param5 :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RasGetEntryPropertiesA = Win32::API::More->new('RASAPI32',
    'DWORD RasGetEntryPropertiesA(LPCSTR param0, LPCSTR param1, LPVOID param2, LPVOID param3, LPVOID param4, LPVOID param5)');
# my $ret = $RasGetEntryPropertiesA->Call($param0, $param1, $param2, $param3, $param4, $param5);
# param0 : LPCSTR optional -> LPCSTR
# param1 : LPCSTR -> LPCSTR
# param2 : RASENTRYA* optional, in/out -> LPVOID
# param3 : DWORD* in/out -> LPVOID
# param4 : BYTE* optional, out -> LPVOID
# param5 : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型