RasGetEntryDialParams

DWORD RasGetEntryDialParams(
  _In_    LPCTSTR         lpszPhonebook,
  _Inout_ LPRASDIALPARAMS lprasdialparams,
  _Out_   LPBOOL          lpfPassword
);

说明

该函数用于获取针对指定电话簿条目最后一次成功调用RasDial或RasSetEntryDialParams函数保存的连接信息。

参数

lpszPhonebook [in]

指向一个包含完整路径的电话簿文件(PBK)。如果参数为空，则该函数使用默认的电话簿文件。默认的电话簿文件由用户在拨号网络对话框的[user preferences]属性窗口中选择。
Windows Me/98/95: 该参数应为NULL,因为拨号网络将电话簿条目存储在注册表中。

lprasdialparams [in, out]

指向RASDIALPARAMS结构。

调用前将结构中的dwSize成员设置为sizeof(RASDIALPARAMS)，szEntryName成员设置为有效的电话簿条目。

该结构用于接收与指定电话簿关联的连接参数。

结构中的szPhoneNumber成员并不会返回电话号码，可以通过 RasGetEntryProperties函数获取号码。调用RasDial函数时如果该成员为NULL，则使用电话簿条目中的号码。

结构中的szPassword成员并不会返回实际的密码，而是一个密码句柄。调用RasSetEntryDialParams和RasDial函数时应使用此句柄代替密码，RasDial函数会通过该句柄获取保存的密码。该句柄内容格式在未来的版本中可能会发生变化，因此不应基于该句柄的格式开发代码。

Windows NT and Windows Me/98/95: 不支持密码句柄。

lpfPassword [out]

指向BOOL类型的变量，用于指示函数是否取回了与电话簿条目关联的用户密码。如果返回值为TRUE，则说明系统存储了该条目的密码。

Windows NT and Windows Me/98/95:如果函数在lprasdialparams->szPassword中返回了密码，则会设置该变量为TRUE。

返回值

成功时返回ERROR_SUCCESS。
失败时返回以下列表中的值之一或来自Routing and Remote Access Error Codes或Winerror.h中定义的错误码。

值	含义
ERROR_BUFFER_INVALID	lprasdialparams或lpfPassword参数无效。或者lprasdialparams指向的缓冲无效。
ERROR_CANNOT_OPEN_PHONEBOOK	电话簿文件损坏或组件丢失。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	电话簿条目不存在。

系统支持

客户端最小支持	Windows 2000专业版
服务端最小支持	Windows 2000 Server
Header	Ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll
Unicode和ANSI名称	RasGetEntryDialParamsW(Unicode)和RasGetEntryDialParamsA(ANSI)