RasPhonebookDlgA 関数 (rasdlg.h)
RasPhonebookDlg 関数は、[ダイヤルアップ ネットワークのメイン] ダイアログ ボックスを表示します。 このモーダル ダイアログ ボックスから、ユーザーは、選択した電話帳エントリをダイヤル、編集、または削除したり、新しい電話帳エントリを作成したり、ユーザー設定を指定したりできます。 RasPhonebookDlg 関数は、ダイアログ ボックスが閉じるとを返します。
構文
BOOL RasPhonebookDlgA(
[in] LPSTR lpszPhonebook,
[in] LPSTR lpszEntry,
[in, out] LPRASPBDLGA lpInfo
);
パラメーター
[in] lpszPhonebook
電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、関数は現在の既定の phone-book ファイルを使用します。 既定の電話帳ファイルは、[ダイヤルアップ ネットワーク] ダイアログ ボックスの [ユーザー設定] プロパティ シートでユーザーが選択したファイルです。
[in] lpszEntry
最初に強調表示する電話帳エントリの名前を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、または指定したエントリが存在しない場合は、ダイアログ ボックスでアルファベット順の一覧の最初のエントリが強調表示されます。
[in, out] lpInfo
追加の入力パラメーターと出力パラメーターを指定する RASPBDLG 構造体へのポインター。
入力時に、この構造体の dwSize メンバーは sizeof( RASPBDLG) を指定する必要があります。
エラーが発生した場合、構造体の dwError メンバーは、出力時にエラー コードを受け取ります。それ以外の場合は、0 を受け取ります。
戻り値
ユーザーが [接続 ] ボタンを選択し、関数が接続を確立した場合、戻り値は TRUE になります。 それ以外の場合、関数は FALSE を返します。
エラーが発生した場合、RASPBDLG 構造体の dwError メンバーは、ルーティングおよびリモート アクセス エラー コードまたは Winerror.h から値を返します。
次のサンプル コードでは、[ ダイヤルアップ ネットワーク ] ダイアログが表示されます。 ダイアログには、既定の Phonebook ファイルからの最初のエントリのダイヤル情報が表示されます。
#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "rasdlg.h"
#pragma comment(lib, "rasapi32.lib")
int main (){
// Initialize the return code
BOOL nRet = TRUE;
// Allocate heap memory for the RASPBLDG structure
RASPBDLG * lpInfo = (LPRASPBDLG)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASPBDLG));
// The dwsize member of lpInfo must contain the structure size, or the
// call to RasPhonebookDlg will fail
lpInfo->dwSize = sizeof(RASPBDLG);
// Open a user dialog box
nRet = RasPhonebookDlg(NULL,NULL,lpInfo);
if(nRet == TRUE){
// The user dialed a connection successfully
printf("User pressed Connect\n");
}else{
if(lpInfo->dwError != 0){
printf("RasPhonebookDlg failed: Error = %d\n", lpInfo->dwError);
}else{
// The user closed the dialog box manually
printf("User pressed Close\n");
}
}
// Free the heap memory for the RASPBLDG structure
HeapFree(GetProcessHeap(), 0, lpInfo);
return 0;
}
解説
注意
rasdlg.h ヘッダーは、RasPhonebookDlg をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | rasdlg.h |
Library | Rasdlg.lib |
[DLL] | Rasdlg.dll |