ホーム › NetworkManagement.Rras › RasPhonebookDlgA

RasPhonebookDlgA

関数

RAS電話帳メインダイアログを表示する(ANSI版)。

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

シグネチャ

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

BOOL RasPhonebookDlgA(
    LPSTR lpszPhonebook,   // optional
    LPSTR lpszEntry,   // optional
    RASPBDLGA* lpInfo
);

パラメーター

名前	型	方向	説明
lpszPhonebook	LPSTR	inoptional	電話帳 (PBK) ファイルの完全パスとファイル名を指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。既定の電話帳ファイルは、Dial-Up Networking ダイアログボックスの User Preferences プロパティシートでユーザーが選択したファイルです。
lpszEntry	LPSTR	inoptional	最初に強調表示する電話帳エントリの名前を指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、または指定されたエントリが存在しない場合、ダイアログボックスはアルファベット順の一覧の最初のエントリを強調表示します。
lpInfo	RASPBDLGA*	inout	追加の入力パラメーターおよび出力パラメーターを指定する RASPBDLG 構造体へのポインター。入力時、この構造体の dwSize メンバーには sizeof( RASPBDLG) を指定する必要があります。エラーが発生した場合、出力時にこの構造体の dwError メンバーにエラーコードが格納されます。エラーが発生しなかった場合は 0 が格納されます。

名前

型

方向

説明

lpszPhonebook

LPSTR

inoptional

電話帳 (PBK) ファイルの完全パスとファイル名を指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。既定の電話帳ファイルは、Dial-Up Networking ダイアログボックスの User Preferences プロパティシートでユーザーが選択したファイルです。

lpszEntry

LPSTR

inoptional

最初に強調表示する電話帳エントリの名前を指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、または指定されたエントリが存在しない場合、ダイアログボックスはアルファベット順の一覧の最初のエントリを強調表示します。

lpInfo

RASPBDLGA*

inout

追加の入力パラメーターおよび出力パラメーターを指定する RASPBDLG 構造体へのポインター。

入力時、この構造体の dwSize メンバーには sizeof( RASPBDLG) を指定する必要があります。

エラーが発生した場合、出力時にこの構造体の dwError メンバーにエラーコードが格納されます。エラーが発生しなかった場合は 0 が格納されます。

戻り値の型: BOOL

公式ドキュメント

RasPhonebookDlg 関数は、メインの Dial-Up Networking ダイアログボックスを表示します。(ANSI)

戻り値

ユーザーが Connect ボタンを選択し、関数が接続を確立した場合、戻り値は TRUE です。それ以外の場合、関数は FALSE を返します。

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

次のサンプルコードは、Dial-Up Networking ダイアログを表示します。このダイアログには、既定の電話帳ファイル内の最初のエントリのダイヤル情報が表示されます。

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

int main (){
    
    // 戻り値を初期化する
    BOOL nRet = TRUE;

    // RASPBLDG 構造体用のヒープ メモリを割り当てる
    RASPBDLG * lpInfo = (LPRASPBDLG)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASPBDLG));
    
    // lpInfo の dwsize メンバーには構造体のサイズを設定する必要がある。設定しないと 
    // RasPhonebookDlg の呼び出しは失敗する
    lpInfo->dwSize = sizeof(RASPBDLG);
     
    // ユーザー ダイアログ ボックスを開く  
    nRet = RasPhonebookDlg(NULL,NULL,lpInfo);
    
    if(nRet == TRUE){
        // ユーザーが接続のダイヤルに成功した
        printf("User pressed Connect
");
    }else{
        if(lpInfo->dwError != 0){
            printf("RasPhonebookDlg failed: Error = %d
", lpInfo->dwError);
        }else{
            // ユーザーが手動でダイアログ ボックスを閉じた
            printf("User pressed Close
");
        }
    }

    // RASPBLDG 構造体のヒープ メモリを解放する
    HeapFree(GetProcessHeap(), 0, lpInfo);
    return 0;
}

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RasPhonebookDlgA(
    LPSTR lpszPhonebook,   // optional
    LPSTR lpszEntry,   // optional
    RASPBDLGA* lpInfo
);

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

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

' lpszPhonebook : LPSTR optional
' lpszEntry : LPSTR optional
' lpInfo : RASPBDLGA* in/out
Declare PtrSafe Function RasPhonebookDlgA Lib "rasdlg" ( _
    ByVal lpszPhonebook As String, _
    ByVal lpszEntry 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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