ホーム › NetworkManagement.Rras › RasDialDlgA

RasDialDlgA

関数

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

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

シグネチャ

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

BOOL RasDialDlgA(
    LPSTR lpszPhonebook,   // optional
    LPSTR lpszEntry,   // optional
    LPSTR lpszPhoneNumber,   // optional
    RASDIALDLG* lpInfo
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

エラーが発生した場合、RasDialDlg は RASDIALDLG 構造体の dwError メンバーに、Routing and Remote Access Error Codes または Winerror.h の値を設定します。

解説(Remarks)

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

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  (ANSI / -A)
#include <windows.h>

BOOL RasDialDlgA(
    LPSTR lpszPhonebook,   // optional
    LPSTR lpszEntry,   // optional
    LPSTR lpszPhoneNumber,   // optional
    RASDIALDLG* lpInfo
);

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

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

' lpszPhonebook : LPSTR optional
' lpszEntry : LPSTR optional
' lpszPhoneNumber : LPSTR optional
' lpInfo : RASDIALDLG* in/out
Declare PtrSafe Function RasDialDlgA Lib "rasdlg" ( _
    ByVal lpszPhonebook As String, _
    ByVal lpszEntry As String, _
    ByVal lpszPhoneNumber As String, _
    ByVal lpInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASDLG.dll')
RasDialDlgA = Fiddle::Function.new(
  lib['RasDialDlgA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszPhonebook : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpszEntry : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpszPhoneNumber : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpInfo : RASDIALDLG* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rasdlg")]
extern "system" {
    fn RasDialDlgA(
        lpszPhonebook: *mut u8,  // LPSTR optional
        lpszEntry: *mut u8,  // LPSTR optional
        lpszPhoneNumber: *mut u8,  // LPSTR 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.Ansi)]
public static extern bool RasDialDlgA([MarshalAs(UnmanagedType.LPStr)] string lpszPhonebook, [MarshalAs(UnmanagedType.LPStr)] string lpszEntry, [MarshalAs(UnmanagedType.LPStr)] string lpszPhoneNumber, IntPtr lpInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASDLG_RasDialDlgA' -Namespace Win32 -PassThru
# $api::RasDialDlgA(lpszPhonebook, lpszEntry, lpszPhoneNumber, lpInfo)

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

出力引数:

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