ホーム › NetworkManagement.Rras › RasDialDlgW

RasDialDlgW

関数

RAS接続のダイヤルダイアログを表示し接続を行う(Unicode版)。

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

シグネチャ

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

BOOL RasDialDlgW(
    LPWSTR lpszPhonebook,   // optional
    LPWSTR lpszEntry,   // optional
    LPWSTR lpszPhoneNumber,   // optional
    RASDIALDLG* lpInfo
);

パラメーター

名前	型	方向	説明
lpszPhonebook	LPWSTR	inoptional	フォンブック (PBK) ファイルの完全なパスとファイル名を指定する、null で終わる文字列へのポインター。このパラメーターが NULL の場合、関数は現在の既定のフォンブックファイルを使用します。既定のフォンブックファイルは、ダイヤルアップネットワークダイアログボックスのユーザー設定プロパティシートでユーザーが選択したものです。
lpszEntry	LPWSTR	inoptional	ダイヤルするフォンブックエントリの名前を指定する、null で終わる文字列へのポインター。
lpszPhoneNumber	LPWSTR	inoptional	フォンブックエントリに格納されている電話番号を上書きする電話番号を指定する、null で終わる文字列へのポインター。このパラメーターが NULL の場合、 RasDialDlg はフォンブックエントリ内の電話番号を使用します。
lpInfo	RASDIALDLG*	inout	追加の入力パラメーターおよび出力パラメーターを指定する RASDIALDLG 構造体へのポインター。この構造体の dwSize メンバーには sizeof(RASDIALDLG) を指定する必要があります。エラーが発生した場合、dwError メンバーにエラーコードが返されます。それ以外の場合は 0 が返されます。

戻り値の型: BOOL

公式ドキュメント

RasDialDlg 関数は、指定されたフォンブックエントリとログオンしているユーザーの資格情報を使用して RAS 接続を確立します。この関数は、接続操作の状態を示す一連のダイアログボックスを表示します。(Unicode)

戻り値

関数が RAS 接続を確立した場合、戻り値は TRUE です。それ以外の場合、この関数は FALSE を返します。

エラーが発生した場合、RasDialDlg は RASDIALDLG 構造体の dwError メンバーに、ルーティングとリモートアクセスのエラーコードまたは Winerror.h の値を設定します。

解説(Remarks)

RasDialDlg 関数は、ユーザーがメインの ダイヤルアップネットワーク ダイアログボックスで ダイヤル ボタンを選択したときに表示されるダイアログボックスと同様の一連のダイアログボックスを表示します。メインのフォンブックダイアログボックスを表示せずに、接続操作用の標準的なユーザーインターフェイスを表示するには、 RasDialDlg 関数を使用します。たとえば、RAS 自動ダイヤルサービスは、リモートアドレスに関連付けられたフォンブックエントリを使用して接続を確立するために、この関数を使用します。

RasDialDlg 関数は、接続操作中にダイアログボックスを表示して、操作の進行状況に関するフィードバックをユーザーに提供します。たとえば、ダイアログボックスは、ダイヤル中であることや、リモートサーバーでユーザーの資格情報を認証中であることなどを示します。また、ダイアログボックスには、ユーザーが操作を終了するための キャンセル ボタンも用意されています。

RasDialDlg は、接続が確立されたとき、またはユーザーが操作をキャンセルしたときに戻ります。

次のサンプルコードは、変数 lpszEntry で指定された既定のフォンブック内のエントリにダイヤルします。

メモこの単純なサンプルは、Windows Vista 以降のバージョンの Windows で実行することを想定しています。sizeof(RASENTRY) の呼び出しは、コードを実行しているオペレーティングシステムのバージョンによって異なる値を返す点に注意してください。これが適切に処理されるように対策を講じてください。

#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "rasdlg.h"
#include <tchar.h>
#include "strsafe.h"

#define PHONE_NUMBER_LENGTH 7
#define DEVICE_NAME_LENGTH 5
#define DEVICE_TYPE_LENGTH 5

DWORD __cdecl wmain(){

    DWORD dwError = ERROR_SUCCESS;
    BOOL nRet = TRUE;
    LPTSTR lpszEntry = L"EntryName";
    LPTSTR lpszphonenumber = L"5555555";
    LPTSTR lpszdevicename = L"Modem";
    LPTSTR lpszdevicetype = RASDT_Modem;

    // Allocate heap memory and initialize RASENTRY structure
    LPRASENTRY lpentry = (LPRASENTRY)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASENTRY));
    // Allocate heap memory and initialize RASDIALDLG structure
    LPRASDIALDLG lpInfo = (LPRASDIALDLG) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASDIALDLG));
    
    if (lpentry == NULL || lpInfo == NULL){
        wprintf(L"HeapAlloc failed");
        HeapFree(GetProcessHeap(), 0, lpentry);
        HeapFree(GetProcessHeap(), 0, lpInfo);
        return 0;
    }

    // The RASDIALDLG and RASENTRY dwSize members have to be initialized or the RasDialDlg()
    // RasSetEntryProperties() APIs will fail below.
    lpInfo->dwSize = sizeof(RASDIALDLG);
    lpentry->dwSize = sizeof(RASENTRY);
    lpentry->dwFramingProtocol = RASFP_Ppp;
    lpentry->dwfOptions = 0;
    lpentry->dwType = RASFP_Ppp;
    dwError |= StringCchCopyN(lpentry->szLocalPhoneNumber, RAS_MaxPhoneNumber, lpszphonenumber, PHONE_NUMBER_LENGTH);
    dwError |= StringCchCopyN(lpentry->szDeviceName, RAS_MaxDeviceName, lpszdevicename, DEVICE_NAME_LENGTH);
    dwError |= StringCchCopyN(lpentry->szDeviceType, RAS_MaxDeviceType, lpszdevicetype, DEVICE_TYPE_LENGTH);
    
    if (dwError != S_OK){
        wprintf(L"Structure initialization failed: Error = %d\n", dwError);
        HeapFree(GetProcessHeap(), 0, lpentry);
        HeapFree(GetProcessHeap(), 0, lpInfo);
        return 0;
    }

    // Validate the new entry's name
    dwError = RasValidateEntryName(NULL, lpszEntry);
    if (dwError != ERROR_SUCCESS){
        wprintf(L"RasValidateEntryName failed: Error = %d\n", dwError);
        HeapFree(GetProcessHeap(), 0, lpentry);
        HeapFree(GetProcessHeap(), 0, lpInfo);
        return 0;
    }

    // Create and set the new entry's properties
    dwError = RasSetEntryProperties(NULL, lpszEntry, lpentry, lpentry->dwSize, NULL, 0);
    if (dwError != ERROR_SUCCESS){
        wprintf(L"RasSetEntryProperties failed: Error = %d\n", dwError);
        HeapFree(GetProcessHeap(), 0, lpentry);
        HeapFree(GetProcessHeap(), 0, lpInfo);
        return 0;
    }
    
    // Connect using the new entry
    nRet = RasDialDlg(NULL, lpszEntry, NULL, lpInfo);
    if (nRet != TRUE){
        wprintf(L"RasDialDlg failed: Error = %d\n", lpInfo->dwError);
    }
    
    // Clean up: delete the new entry
    dwError = RasDeleteEntry(NULL, lpszEntry);
    if (dwError != ERROR_SUCCESS){
        wprintf(L"RasDeleteEntry failed: Error = %d\n", dwError);
    }
    
    HeapFree(GetProcessHeap(), 0, lpentry);
    HeapFree(GetProcessHeap(), 0, lpInfo);

    return 0;
}

メモ

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

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

各言語での呼び出し定義

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

BOOL RasDialDlgW(
    LPWSTR lpszPhonebook,   // optional
    LPWSTR lpszEntry,   // optional
    LPWSTR lpszPhoneNumber,   // optional
    RASDIALDLG* lpInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("RASDLG.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool RasDialDlgW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPhonebook,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpszEntry,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPhoneNumber,   // LPWSTR optional
    IntPtr lpInfo   // RASDIALDLG* in/out
);

<DllImport("RASDLG.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasDialDlgW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszPhonebook As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszEntry As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszPhoneNumber As String,   ' LPWSTR optional
    lpInfo As IntPtr   ' RASDIALDLG* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszPhonebook : LPWSTR optional
' lpszEntry : LPWSTR optional
' lpszPhoneNumber : LPWSTR optional
' lpInfo : RASDIALDLG* in/out
Declare PtrSafe Function RasDialDlgW Lib "rasdlg" ( _
    ByVal lpszPhonebook As LongPtr, _
    ByVal lpszEntry As LongPtr, _
    ByVal lpszPhoneNumber As LongPtr, _
    ByVal lpInfo As LongPtr) 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

RasDialDlgW = ctypes.windll.rasdlg.RasDialDlgW
RasDialDlgW.restype = wintypes.BOOL
RasDialDlgW.argtypes = [
    wintypes.LPCWSTR,  # lpszPhonebook : LPWSTR optional
    wintypes.LPCWSTR,  # lpszEntry : LPWSTR optional
    wintypes.LPCWSTR,  # lpszPhoneNumber : LPWSTR optional
    ctypes.c_void_p,  # lpInfo : RASDIALDLG* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASDLG.dll')
RasDialDlgW = Fiddle::Function.new(
  lib['RasDialDlgW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszPhonebook : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # lpszEntry : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # lpszPhoneNumber : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # lpInfo : RASDIALDLG* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "rasdlg")]
extern "system" {
    fn RasDialDlgW(
        lpszPhonebook: *mut u16,  // LPWSTR optional
        lpszEntry: *mut u16,  // LPWSTR optional
        lpszPhoneNumber: *mut u16,  // LPWSTR optional
        lpInfo: *mut RASDIALDLG  // RASDIALDLG* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("RASDLG.dll", CharSet = CharSet.Unicode)]
public static extern bool RasDialDlgW([MarshalAs(UnmanagedType.LPWStr)] string lpszPhonebook, [MarshalAs(UnmanagedType.LPWStr)] string lpszEntry, [MarshalAs(UnmanagedType.LPWStr)] string lpszPhoneNumber, IntPtr lpInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASDLG_RasDialDlgW' -Namespace Win32 -PassThru
# $api::RasDialDlgW(lpszPhonebook, lpszEntry, lpszPhoneNumber, lpInfo)

#uselib "RASDLG.dll"
#func global RasDialDlgW "RasDialDlgW" wptr, wptr, wptr, wptr
; RasDialDlgW lpszPhonebook, lpszEntry, lpszPhoneNumber, varptr(lpInfo)   ; 戻り値は stat
; lpszPhonebook : LPWSTR optional -> "wptr"
; lpszEntry : LPWSTR optional -> "wptr"
; lpszPhoneNumber : LPWSTR optional -> "wptr"
; lpInfo : RASDIALDLG* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RASDLG.dll"
#cfunc global RasDialDlgW "RasDialDlgW" wstr, wstr, wstr, var
; res = RasDialDlgW(lpszPhonebook, lpszEntry, lpszPhoneNumber, lpInfo)
; lpszPhonebook : LPWSTR optional -> "wstr"
; lpszEntry : LPWSTR optional -> "wstr"
; lpszPhoneNumber : LPWSTR optional -> "wstr"
; lpInfo : RASDIALDLG* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RASDLG.dll"
#cfunc global RasDialDlgW "RasDialDlgW" wstr, wstr, wstr, sptr
; res = RasDialDlgW(lpszPhonebook, lpszEntry, lpszPhoneNumber, varptr(lpInfo))
; lpszPhonebook : LPWSTR optional -> "wstr"
; lpszEntry : LPWSTR optional -> "wstr"
; lpszPhoneNumber : LPWSTR optional -> "wstr"
; lpInfo : RASDIALDLG* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。