ホーム › NetworkManagement.Rras › RasPhonebookDlgW

RasPhonebookDlgW

関数

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

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

シグネチャ

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

BOOL RasPhonebookDlgW(
    LPWSTR lpszPhonebook,   // optional
    LPWSTR lpszEntry,   // optional
    RASPBDLGW* lpInfo
);

パラメーター

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

名前

型

方向

説明

lpszPhonebook

LPWSTR

inoptional

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

lpszEntry

LPWSTR

inoptional

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

lpInfo

RASPBDLGW*

inout

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

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

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

戻り値の型: BOOL

公式ドキュメント

RasPhonebookDlg 関数は、メインの ダイヤルアップネットワーク ダイアログボックスを表示します。(Unicode)

戻り値

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

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

次のサンプルコードは、ダイヤルアップネットワーク ダイアログを表示します。このダイアログには、既定の電話帳ファイルの先頭のエントリのダイヤル情報が表示されます。

#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 を定義しています。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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