ホーム › NetworkManagement.Rras › RasEnumConnectionsW

RasEnumConnectionsW

関数

現在アクティブなRAS接続を列挙する(Unicode版)。

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

シグネチャ

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

DWORD RasEnumConnectionsW(
    RASCONNW* param0,   // optional
    DWORD* param1,
    DWORD* param2
);

パラメーター

名前	型	方向	説明
param0	RASCONNW*	inoutoptional	アクティブな接続情報を受け取るRASCONNW構造体配列へのポインタ。先頭要素のdwSize設定が必要。
param1	DWORD*	inout	入力でバッファのバイト数、出力で必要バイト数を格納するポインタ。
param2	DWORD*	out	列挙された接続数を受け取るポインタ。

戻り値の型: DWORD

公式ドキュメント

RasEnumConnections 関数は、アクティブなすべての RAS 接続を列挙します。各接続のハンドルとフォンブックエントリ名を返します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値はルーティングとリモートアクセスのエラーコードまたは Winerror.h に定義された値です。

戻り値	説明
ERROR_BUFFER_TOO_SMALL	lprasconn バッファーのサイズが十分ではありません。lpcb パラメーターの値が、関数を呼び出す前に設定しておく必要がある lprasconn パラメーター内の dwSize メンバーより小さくなっています。関数は必要なバッファーサイズを lpcb が指す変数に返します。

解説(Remarks)

フォンブックエントリ名を指定せずに接続を確立した場合、その接続について返される情報には、先頭に "." が付いた接続先の電話番号が格納されます。

次のコードサンプルでは、RasEnumConnections を使用してアクティブな RAS 接続を列挙します。

#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 dwConnections = 0;
    LPRASCONN lpRasConn = NULL;
    
    // Call RasEnumConnections with lpRasConn = NULL. dwCb is returned with the required buffer size and 
    // a return code of ERROR_BUFFER_TOO_SMALL
    dwRet = RasEnumConnections(lpRasConn, &dwCb, &dwConnections);

    if (dwRet == ERROR_BUFFER_TOO_SMALL){
        // Allocate the memory needed for the array of RAS structure(s).
        lpRasConn = (LPRASCONN) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dwCb);
        if (lpRasConn == NULL){
            wprintf(L"HeapAlloc failed!\n");
            return 0;
        }
        // The first RASCONN structure in the array must contain the RASCONN structure size
        lpRasConn[0].dwSize = sizeof(RASCONN);
        
        // Call RasEnumConnections to enumerate active connections
        dwRet = RasEnumConnections(lpRasConn, &dwCb, &dwConnections);

        // If successful, print the names of the active connections.
        if (ERROR_SUCCESS == dwRet){
            wprintf(L"The following RAS connections are currently active:\n");
            for (DWORD i = 0; i < dwConnections; i++){
                         wprintf(L"%s\n", lpRasConn[i].szEntryName);
                  }
        }
        //Deallocate memory for the connection buffer
        HeapFree(GetProcessHeap(), 0, lpRasConn);
        lpRasConn = NULL;
        return 0;
    }

    // There was either a problem with RAS or there are no connections to enumerate    
    if(dwConnections >= 1){
        wprintf(L"The operation failed to acquire the buffer size.\n");
    }else{
        wprintf(L"There are no active RAS connections.\n");
    }

    return 0;
}

RasEnumConnections は、RAS が正常に接続を完了するまで、その接続を Active として列挙することはできません。

Windows Me/98/95: RasEnumConnections は、ダイヤルを開始した時点で接続を Active として列挙します。

アクティブな接続を列挙して確認する最も確実な方法は、RasEnumConnections または RasDial を呼び出して接続ハンドルを取得し、続いて RasGetConnectStatus を呼び出して実際の接続状態を判断することです。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RasEnumConnectionsW(
    RASCONNW* param0,   // optional
    DWORD* param1,
    DWORD* param2
);

[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RasEnumConnectionsW(
    IntPtr param0,   // RASCONNW* optional, in/out
    ref uint param1,   // DWORD* in/out
    out uint param2   // DWORD* out
);

<DllImport("RASAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasEnumConnectionsW(
    param0 As IntPtr,   ' RASCONNW* optional, in/out
    ByRef param1 As UInteger,   ' DWORD* in/out
    <Out> ByRef param2 As UInteger   ' DWORD* out
) As UInteger
End Function

' param0 : RASCONNW* optional, in/out
' param1 : DWORD* in/out
' param2 : DWORD* out
Declare PtrSafe Function RasEnumConnectionsW Lib "rasapi32" ( _
    ByVal param0 As LongPtr, _
    ByRef param1 As Long, _
    ByRef param2 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

RasEnumConnectionsW = ctypes.windll.rasapi32.RasEnumConnectionsW
RasEnumConnectionsW.restype = wintypes.DWORD
RasEnumConnectionsW.argtypes = [
    ctypes.c_void_p,  # param0 : RASCONNW* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # param1 : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # param2 : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "rasapi32")]
extern "system" {
    fn RasEnumConnectionsW(
        param0: *mut RASCONNW,  // RASCONNW* optional, in/out
        param1: *mut u32,  // DWORD* in/out
        param2: *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 RasEnumConnectionsW(IntPtr param0, ref uint param1, out uint param2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasEnumConnectionsW' -Namespace Win32 -PassThru
# $api::RasEnumConnectionsW(param0, param1, param2)

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

出力引数:

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