DWORD RasSetEntryDialParams(
_In_ LPCTSTR lpszPhonebook,
_In_ LPRASDIALPARAMS lprasdialparams,
_In_ BOOL fRemovePassword
);
说明
该函数用于修改指定的电话簿条目连接参数信息,这些信息可能是通过本函数修改进行保存,也可能是使用RasDial函数对该地址最后一次成功拨号后保存。
参数
lpszPhonebook [in]
指向一个包含完整路径的电话簿文件(PBK)。如果参数为空,则该函数使用默认的电话簿文件。默认的电话簿文件由用户在拨号网络对话框的[user preferences]属性窗口中选择。
Windows Me/98/95: 该参数应为NULL,因为拨号网络将电话簿条目存储在注册表中。
lprasdialparams [in]
指向RASDIALPARAMS结构,包含与指定条目关联的连接参数信息。该结构的成员用法及说明如下。
成员 | 含义 |
---|---|
dwSize | 指定为sizeof(RASDIALPARAMS)。 |
szEntryName | 指定电话簿条目名称。 |
szPhoneNumber | 未使用,填NULL。 |
szCallbackNumber | 回拨号码。如果该成员为空字符串,则回拨号码不会被改变。 |
szUserName | 指定该条目的登录用户名称。如果该成员是空字符串,则用户名称不会被改变。 |
szPassword | 指定用户密码。如果szUserName为空字符串,则密码不会被改变。如果该成员是空字符串并且fRemovePassword参数为FALSE,则密码被清除。如果fRemovePassword参数为TRUE,则忽略该成员的值并且清除密码。 Windows NT 4.0: 不论szUserName的值是否为空串,密码都会被修改。 Windows XP/2000: 如果该成员的值是由RasGetCredentials函数或RasGetEntryDialParams函数返回的密码句柄,则不会修改密码。 |
szDomain | 指定登录到域的名称。如果该成员为空字符串,则域名称不会被改变。 |
dwSubEntry | 指定建立连接时拨号的初始子条目索引(从1开始)。 |
dwCallbackId | 应用程序指定的值,将由RAS传递给RasDialFunc2函数。 |
fRemovePassword [in]
指示是否删除电话簿条目存储的用户密码。如果为TRUE,则清除密码。
返回值
成功时返回ERROR_SUCCESS。
失败时返回以下列表中的值之一或来自Routing and Remote Access Error Codes或Winerror.h中定义的错误码。
值 | 含义 |
---|---|
ERROR_BUFFER_INVALID | lprasdialparams参数指向的缓冲无效。 |
ERROR_CANNOT_OPEN_PHONEBOOK | 电话簿损坏或组件丢失。 |
RROR_CANNOT_FIND_PHONEBOOK_ENTRY | 指定的电话簿条目不存在。 |
注意事项
使用RasSetEntryProperties函数来创建一个新电话簿条目。
Windows XP及以后版本: 不要使用RasSetEntryDialParams函数来修改用户凭证。可以使用RasSetCredentials函数来修改凭证,其它成员数据可以在调用RasDial函数时直接设置在lpRasDialParams参数指向的结构中。
系统支持
客户端最小支持 | Windows 2000 专业版 |
---|---|
服务端最小支持 | Windows 2000 Server |
Header | Ras.h |
Library | Rasapi32.lib |
DLL | Rasapi32.dll |
Unicode和ANSI名称 | RasSetEntryDialParamsW(Unicode)和RasSetEntryDialParamsA(ANSI) |