RasGetEntryDialParamsA 函数（ras.h）

项目
11/20/2024

RasGetEntryDialParams 函数检索上次成功调用 RasDial 或 RasSetEntryDialParams 函数为指定的电话簿条目保存的连接信息。

语法

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

参数

[in] unnamedParam1

指向 null终止字符串的指针，该字符串指定电话簿（PBK）文件的完整路径和文件名。如果此参数 NULL，则该函数使用当前的默认电话簿文件。默认电话簿文件是用户在 用户首选项拨号网络 对话框中选择的文件。

Windows Me/98/95：此参数应始终 NULL。拨号网络将电话簿条目存储在注册表中，而不是存储在电话簿文件中。

[in, out] unnamedParam2

指向 RASDIALPARAMS 结构的指针。

在输入时，dwSize 成员指定 RASDIALPARAMS 结构的大小，szEntryName 成员指定有效的电话簿条目。

在输出中，结构接收与指定的电话簿条目关联的连接参数。

请注意，szPhoneNumber 结构成员未收到与电话簿条目关联的电话号码。若要获取与电话簿条目关联的电话号码，请调用 RasGetEntryProperties 函数。如果 szPhoneNumber 是传递给 RasDial的 RASDIALPARAMS 结构中的空字符串，RasDial 将使用存储在电话簿条目中的电话号码。

szPasswordRASDIALPARAMS 结构的成员不返回实际密码。相反，szPassword 包含已保存密码的句柄。将此句柄替换为对 RasSetEntryDialParams 和 RasDial的后续调用中保存的密码。当显示此句柄时，RasDial 检索和使用保存的密码。此句柄的值可能会在操作系统的未来版本中更改;不开发依赖于此值的内容或格式的代码。

Windows NT 和 Windows Me/98/95：不支持 安全密码功能。

[out] unnamedParam3

指向指示函数是否检索与电话簿条目用户名关联的密码的标志的指针。如果系统为指定条目保存了密码，则 lpfPassword 参数 TRUE。如果系统没有保存此条目的密码，lpfPasswordFALSE。

Windows NT 和 Windows Me/98/95：如果 RASDIALPARA MS 成员指向的 szPassword 成员中返回用户密码，则函数将此标志设置为 TRUE。

返回值

如果函数成功，则返回值 ERROR_SUCCESS。

如果函数失败，则返回值是以下错误代码之一或来自路由和远程访问错误代码或 Winerror.h 的值。

价值	描述
ERROR_BUFFER_INVALID	lprasdialparams 或 lpfPassword 指针无效，或者 lprasdialparams 缓冲区无效。
ERROR_CANNOT_OPEN_PHONEBOOK	电话簿已损坏或缺少组件。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	电话簿条目不存在。

言论

注意

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

要求

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