rasEntryDlgA 函数 (rasdlg.h)

项目
03/13/2024

RasEntryDlg 函数显示允许用户操作电话簿条目的模式属性表。如果编辑或复制现有的电话簿条目，函数将显示电话簿条目属性表。当用户关闭属性表时， RasEntryDlg 函数将返回。

语法

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

参数

[in] lpszPhonebook

指向以 null 结尾的字符串的指针，该字符串指定电话簿 (PBK) 文件的完整路径和文件名。如果此参数为 NULL，则该函数使用当前默认的电话簿文件。默认电话簿文件是用户在“拨号网络”对话框的“用户首选项”属性表中选择的文件。

[in] lpszEntry

指向以 null 结尾的字符串的指针，该字符串指定要编辑、复制或创建的电话簿条目的名称。

如果要编辑或复制条目，此参数是现有电话簿条目的名称。如果要复制条目，请在 RASENTRYDLG 结构的 dwFlags 成员中设置RASEDFLAG_CloneEntry标志。

注意自 Windows Vista 和 Windows Server 2008 起，RASEDFLAG_CloneEntry标志已弃用。它可能在后续版本中变更或不可用。请改为通过调用 RasGetEntryProperties 来复制条目以获取该条目，然后调用 RasSetEntryProperties 以使用新名称保存条目。

如果要创建条目，此参数是用户可以更改的默认新条目名称。如果此参数为 NULL，则该函数提供默认名称。如果要创建条目，请在 RASENTRYDLG 结构的 dwFlags 成员中设置RASEDFLAG_NewEntry标志。

[in] lpInfo

指向 RASENTRYDLG 结构的指针，该结构指定其他输入和输出参数。此结构的 dwSize 成员必须指定 size of (RASENTRYDLG) 。使用 dwFlags 成员指示是要创建、编辑还是复制条目。如果发生错误， dwError 成员将返回错误代码;否则，它将返回零。

返回值

如果用户创建、复制或编辑电话簿条目，则返回值为 TRUE。否则，函数返回 FALSE。

如果发生错误，RasEntryDlg 会将 RASENTRYDLG 结构的 dwError 成员设置为路由和远程访问错误代码或 Winerror.h 中的值。

注解

RasCreatePhonebookEntry 和 RasEditPhonebookEntry 函数调用 RasEntryDlg 函数。

下面的示例代码显示一个属性表来创建新条目。 lpszEntry 变量指定新条目的默认名称。

#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;
}

注意

rasdlg.h 标头将 RASENTRYDLG 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	rasdlg.h
Library	Rasdlg.lib
DLL	Rasdlg.dll