RasGetEntryDialParamsA 函数 (ras.h)

项目
08/25/2023

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

语法

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

parameters

[in] unnamedParam1

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

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

[in, out] unnamedParam2

指向 RASDIALPARAMS 结构的指针。

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

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

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

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

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

[out] unnamedParam3

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

Windows NT 和 Windows Me/98/95： 如果用户的密码是在 lprasdialparams 指向的 RASDIALPARAMS 结构的 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 [仅限桌面应用]
目标平台	Windows
标头	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll