Fungsi RasEntryDlgA (rasdlg.h)

Artikel
03/01/2024

Fungsi RasEntryDlg menampilkan lembar properti modal yang memungkinkan pengguna memanipulasi entri buku telepon. Jika mengedit atau menyalin entri buku telepon yang ada, fungsi akan menampilkan lembar properti entri buku telepon. Fungsi RasEntryDlg kembali saat pengguna menutup lembar properti.

Sintaks

BOOL RasEntryDlgA(
  [in] LPSTR          lpszPhonebook,
  [in] LPSTR          lpszEntry,
  [in] LPRASENTRYDLGA lpInfo
);

Parameter

[in] lpszPhonebook

Penunjuk ke string yang dihentikan null yang menentukan jalur lengkap dan nama file file buku telepon (PBK). Jika parameter ini NULL, fungsi menggunakan file buku telepon default saat ini. File buku telepon default adalah file yang dipilih oleh pengguna di lembar properti Preferensi Pengguna dari kotak dialog Jaringan Dial-Up .

[in] lpszEntry

Penunjuk ke string yang dihentikan null yang menentukan nama entri buku telepon untuk mengedit, menyalin, atau membuat.

Jika Anda mengedit atau menyalin entri, parameter ini adalah nama entri buku telepon yang ada. Jika Anda menyalin entri, atur bendera RASEDFLAG_CloneEntry di anggota dwFlags dari struktur RASENTRYDLG .

Catatan Bendera RASEDFLAG_CloneEntry telah ditolak, pada Windows Vista dan Windows Server 2008. Ini dapat diubah atau tidak tersedia dalam versi berikutnya. Sebagai gantinya, salin entri dengan memanggil RasGetEntryProperties untuk mendapatkan entri dan kemudian memanggil RasSetEntryProperties untuk menyimpan entri dengan nama baru.

Jika Anda membuat entri, parameter ini adalah nama entri baru default yang dapat diubah pengguna. Jika parameter ini NULL, fungsi menyediakan nama default. Jika Anda membuat entri, atur bendera RASEDFLAG_NewEntry di anggota dwFlags dari struktur RASENTRYDLG .

[in] lpInfo

Arahkan ke struktur RASENTRYDLG yang menentukan parameter input dan output tambahan. Anggota dwSize dari struktur ini harus menentukan sizeof(RASENTRYDLG). Gunakan anggota dwFlags untuk menunjukkan apakah Anda membuat, mengedit, atau menyalin entri. Jika terjadi kesalahan, anggota dwError mengembalikan kode kesalahan; jika tidak, ia mengembalikan nol.

Mengembalikan nilai

Jika pengguna membuat, menyalin, atau mengedit entri buku telepon, nilai yang dikembalikan adalah TRUE. Jika tidak, fungsi mengembalikan FALSE.

Jika terjadi kesalahan, RasEntryDlg menetapkan anggota dwError dari struktur RASENTRYDLG ke nilai dari Perutean dan Kode Kesalahan Akses Jarak Jauh atau Winerror.h.

Keterangan

Fungsi RasCreatePhonebookEntry dan RasEditPhonebookEntry memanggil fungsi RasEntryDlg .

Kode sampel berikut memunculkan lembar properti untuk membuat entri baru. Variabel lpszEntry menentukan nama default untuk entri baru.

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

DWORD __cdecl wmain(){

    DWORD dwRet = ERROR_SUCCESS;
    BOOL nRet = TRUE;
    LPTSTR lpszEntry = L"EntryName";

    // Allocate heap memory and initialize RASENTRYDLG structure
    LPRASENTRYDLG lpEntry = (LPRASENTRYDLG)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASENTRYDLG));
    if (lpEntry == NULL){
        wprintf(L"HeapAlloc failed.\n");
        return 0;
    }
    
    // The RASENTRYDLG->dwSize member has to be initialized or the RRAS APIs will fail below.
    lpEntry->dwSize = sizeof(RASENTRYDLG);
    lpEntry->dwFlags |= RASEDFLAG_NewEntry;

    // Create the new entry using a user dialog
    nRet = RasEntryDlg(NULL, lpszEntry, lpEntry);

    // Any error codes are returned in lpEntry
    dwRet = lpEntry->dwError;
    
    if (nRet == TRUE) {
        wprintf(L"New entry created: %s\n", lpEntry->szEntry);

        // Clean up: delete the new entry
        dwRet = RasDeleteEntry(NULL, lpszEntry);
        if (dwRet != ERROR_SUCCESS) {
            wprintf(L"RasDeleteEntry failed: Error = %d\n", dwRet);
        }

    } 
    else {
        if (dwRet != ERROR_SUCCESS) {
            wprintf(L"RasEntryDlg failed: Error = %d\n", dwRet);
        }
        else {
            wprintf(L"User pressed Cancel\n");
        }
    }

    HeapFree(GetProcessHeap(), 0, lpEntry);
    return 0;
}

Catatan

Header rasdlg.h mendefinisikan RASENTRYDLG sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	rasdlg.h
Pustaka	Rasdlg.lib
DLL	Rasdlg.dll