ホーム › NetworkManagement.Rras › RasEnumEntriesW

RasEnumEntriesW

関数

電話帳内のRAS接続エントリ名を列挙する(Unicode版)。

DLLRASAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RASAPI32.dll  (Unicode / -W)
#include <windows.h>

DWORD RasEnumEntriesW(
    LPCWSTR param0,   // optional
    LPCWSTR param1,   // optional
    RASENTRYNAMEW* param2,   // optional
    DWORD* param3,
    DWORD* param4
);

パラメーター

名前	型	方向	説明
param0	LPCWSTR	inoptional	予約。NULLを指定する。
param1	LPCWSTR	inoptional	列挙対象の電話帳ファイルのパスを指すワイド文字列。NULLで既定の電話帳を使う。
param2	RASENTRYNAMEW*	inoutoptional	列挙されたエントリ名を受け取るRASENTRYNAMEW構造体配列へのポインタ。
param3	DWORD*	inout	入力でバッファのバイト数、出力で必要バイト数を格納するポインタ。
param4	DWORD*	out	列挙されたエントリ数を受け取るポインタ。

戻り値の型: DWORD

公式ドキュメント

RasEnumEntries 関数は、リモートアクセス電話帳内のすべてのエントリ名を列挙します。(Unicode)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing and Remote Access Error Codes や Winerror.h の値です。

値	意味
ERROR_BUFFER_TOO_SMALL	lprasentryname バッファーが十分な大きさではありません。lpcb パラメーターが、関数を呼び出す前に設定しておく必要がある lprasentryname パラメーター内の dwSize メンバーよりも小さくなっています。関数は、必要なバッファーサイズを lpcb が指す変数に返します。 Windows Vista 以降: lprasentryname バッファーに NULL を設定し、lpcb が指す変数に 0 を設定できます。関数は、必要なバッファーサイズを lpcb が指す変数に返します。
ERROR_INVALID_SIZE	lprasentryname が指す RASENTRYNAME 構造体の dwSize の値が、現在のプラットフォームではサポートされていない構造体のバージョンを示しています。たとえば Windows 95 では、dwSize が RASENTRYNAME に dwFlags メンバーと szPhonebookPath メンバーが含まれることを示している場合、これらのメンバーは Windows 95 ではサポートされていない (Windows 2000 以降でのみサポートされる) ため、 RasEnumEntries はこのエラーを返します。
ERROR_NOT_ENOUGH_MEMORY	この操作を完了するのに十分なメモリを関数が割り当てられませんでした。

解説(Remarks)

次のサンプルコードは、Windows Vista 以降の Windows で RAS 電話帳エントリを列挙します。このコードは、まず RasEnumEntries を呼び出して、渡すべきバッファーのサイズを取得します。続いて再度 RasEnumEntries を呼び出してエントリを列挙します。2 回目の呼び出しでは、構造体のバージョンを指定するために、バッファー内の最初の RASENTRYNAME 構造体の dwSize メンバーに sizeof(RASENTRYNAME) を設定している点に注意してください。

#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "raserror.h"
#pragma comment(lib, "rasapi32.lib")

DWORD __cdecl wmain(){

    DWORD dwCb = 0;
    DWORD dwRet = ERROR_SUCCESS;
    DWORD dwEntries = 0;
    LPRASENTRYNAME lpRasEntryName = NULL;
    
    // lpRasEntryName = NULL として RasEnumEntries を呼び出す。dwCb に必要なバッファー サイズが返され、
    // 戻り値は ERROR_BUFFER_TOO_SMALL となる
    dwRet = RasEnumEntries(NULL, NULL, lpRasEntryName, &dwCb, &dwEntries);

    if (dwRet == ERROR_BUFFER_TOO_SMALL){
        // RAS エントリ名の配列に必要なメモリを割り当てる。
        lpRasEntryName = (LPRASENTRYNAME) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dwCb);
        if (lpRasEntryName == NULL){
            wprintf(L"HeapAlloc failed!\n");
            return 0;
        }
        // 配列内の最初の RASENTRYNAME 構造体には構造体のサイズを設定する必要がある
        lpRasEntryName[0].dwSize = sizeof(RASENTRYNAME);
        
        // RasEnumEntries を呼び出してすべての RAS エントリ名を列挙する
        dwRet = RasEnumEntries(NULL, NULL, lpRasEntryName, &dwCb, &dwEntries);

        // 成功した場合は RAS エントリ名を出力する 
        if (ERROR_SUCCESS == dwRet){
            wprintf(L"The following RAS entry names were found:\n");
            for (DWORD i = 0; i < dwEntries; i++){
                wprintf(L"%s\n", lpRasEntryName[i].szEntryName);
            }
        }
        // 接続バッファーのメモリを解放する
        HeapFree(GetProcessHeap(), 0, lpRasEntryName);
        lpRasEntryName = NULL;
        return 0;
    }

    // RAS に問題があったか、列挙すべき RAS エントリ名が存在する    
    if(dwEntries >= 1){
        wprintf(L"The operation failed to acquire the buffer size.\n");
    }else{
        wprintf(L"There were no RAS entry names found:.\n");
    }

    return 0;
}

メモ

ras.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RasEnumEntries を定義します。エンコード中立のエイリアスと、エンコード中立でないコードを混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーになる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// RASAPI32.dll  (Unicode / -W)
#include <windows.h>

DWORD RasEnumEntriesW(
    LPCWSTR param0,   // optional
    LPCWSTR param1,   // optional
    RASENTRYNAMEW* param2,   // optional
    DWORD* param3,
    DWORD* param4
);

[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RasEnumEntriesW(
    [MarshalAs(UnmanagedType.LPWStr)] string param0,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string param1,   // LPCWSTR optional
    IntPtr param2,   // RASENTRYNAMEW* optional, in/out
    ref uint param3,   // DWORD* in/out
    out uint param4   // DWORD* out
);

<DllImport("RASAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasEnumEntriesW(
    <MarshalAs(UnmanagedType.LPWStr)> param0 As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> param1 As String,   ' LPCWSTR optional
    param2 As IntPtr,   ' RASENTRYNAMEW* optional, in/out
    ByRef param3 As UInteger,   ' DWORD* in/out
    <Out> ByRef param4 As UInteger   ' DWORD* out
) As UInteger
End Function

' param0 : LPCWSTR optional
' param1 : LPCWSTR optional
' param2 : RASENTRYNAMEW* optional, in/out
' param3 : DWORD* in/out
' param4 : DWORD* out
Declare PtrSafe Function RasEnumEntriesW Lib "rasapi32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal param2 As LongPtr, _
    ByRef param3 As Long, _
    ByRef param4 As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RasEnumEntriesW = ctypes.windll.rasapi32.RasEnumEntriesW
RasEnumEntriesW.restype = wintypes.DWORD
RasEnumEntriesW.argtypes = [
    wintypes.LPCWSTR,  # param0 : LPCWSTR optional
    wintypes.LPCWSTR,  # param1 : LPCWSTR optional
    ctypes.c_void_p,  # param2 : RASENTRYNAMEW* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # param3 : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # param4 : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasEnumEntriesW = Fiddle::Function.new(
  lib['RasEnumEntriesW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # param1 : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # param2 : RASENTRYNAMEW* optional, in/out
    Fiddle::TYPE_VOIDP,  # param3 : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # param4 : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "rasapi32")]
extern "system" {
    fn RasEnumEntriesW(
        param0: *const u16,  // LPCWSTR optional
        param1: *const u16,  // LPCWSTR optional
        param2: *mut RASENTRYNAMEW,  // RASENTRYNAMEW* optional, in/out
        param3: *mut u32,  // DWORD* in/out
        param4: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RasEnumEntriesW([MarshalAs(UnmanagedType.LPWStr)] string param0, [MarshalAs(UnmanagedType.LPWStr)] string param1, IntPtr param2, ref uint param3, out uint param4);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasEnumEntriesW' -Namespace Win32 -PassThru
# $api::RasEnumEntriesW(param0, param1, param2, param3, param4)

#uselib "RASAPI32.dll"
#func global RasEnumEntriesW "RasEnumEntriesW" wptr, wptr, wptr, wptr, wptr
; RasEnumEntriesW param0, param1, varptr(param2), varptr(param3), varptr(param4)   ; 戻り値は stat
; param0 : LPCWSTR optional -> "wptr"
; param1 : LPCWSTR optional -> "wptr"
; param2 : RASENTRYNAMEW* optional, in/out -> "wptr"
; param3 : DWORD* in/out -> "wptr"
; param4 : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RASAPI32.dll"
#cfunc global RasEnumEntriesW "RasEnumEntriesW" wstr, wstr, var, var, var
; res = RasEnumEntriesW(param0, param1, param2, param3, param4)
; param0 : LPCWSTR optional -> "wstr"
; param1 : LPCWSTR optional -> "wstr"
; param2 : RASENTRYNAMEW* optional, in/out -> "var"
; param3 : DWORD* in/out -> "var"
; param4 : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RASAPI32.dll"
#cfunc global RasEnumEntriesW "RasEnumEntriesW" wstr, wstr, sptr, sptr, sptr
; res = RasEnumEntriesW(param0, param1, varptr(param2), varptr(param3), varptr(param4))
; param0 : LPCWSTR optional -> "wstr"
; param1 : LPCWSTR optional -> "wstr"
; param2 : RASENTRYNAMEW* optional, in/out -> "sptr"
; param3 : DWORD* in/out -> "sptr"
; param4 : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。