DWORD RasSetAutodialAddress(
_In_ LPCTSTR lpszAddress,
_In_ DWORD dwReserved,
_In_ LPRASAUTODIALENTRY lpAutoDialEntries,
_In_ DWORD dwcbAutoDialEntries,
_In_ DWORD dwcAutoDialEntries
);
说明
该函数可以可以向自动拨号(AutoDial)数据库中添加一个地址,也可以删除一个已存在的地址。
参数
lpszAddress [in]
指定要添加、删除或修改的地址。可以是IP地址、Internet域名或NetBIOS名称。
如果该参数为NULL,则设置默认的Internet连接,如果是空字符串,则删除默认Internet连接。
dwReserved [in]
保留未用,必须为0。
lpAutoDialEntries [in]
指向一个与lpszAddress地址关联的一个或多个RASAUTODIALENTRY结构。如果该参数为NULL并且dwcbAutoDialEntries参数为0,则该函数删除所有与lpszAddress关联的结构。
dwcbAutoDialEntries [in]
指定lpAutoDialEntries参数指向的缓冲长度字节数。
dwcAutoDialEntries [in]
指定lpAutoDialEntries指向的缓冲包含的RASAUTODIALENTRY结构数量。
返回值
成功时返回ERROR_SUCCESS。
失败时返回以下列表中的值之一或来自Routing and Remote Access Error Codes或Winerror.h中定义的错误码。
值 | 含义 |
---|---|
ERROR_INVALID_SIZE | RASAUTODIALENTRY结构的dwSize成员值不正确。 |
ERROR_INVALID_PARAMETER | lpszAddress参数为NULL。 |
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY | lpAutoDialEntries参数指向的电话簿条目名称不存在。 |
注意事项
自动拨号数据库中的一个地址可以和多个RASAUTODIALENTRY结构关联。每个结构描述一个特定的TAPI拨号位置信息。
若lpszAddress参数指定的地址存在于数据库中,并且lpAutoDialEntries参数不为NULL,则该函数修改与目标地址关联的所有RASAUTODIALENTRY条目。如果RASAUTODIALENTRY条目某一项已存在于数据库中,则直接替换掉,否则将RASAUTODIALENTRY条目追加到关联的集合中。
若lpszAddress参数指定的地址存在于数据库中,并且lpAutoDialEntries为NULL,则该函数删除此地址及其关联的RASAUTODIALENTRY条目。
若lpszAddress参数指定的地址不存在,则将该地址及其关联的RASAUTODIALENTRY条目添加到数据库中。
RAS支持本机设置一个全局默认连接,也支持每个用户一个默认连接。
若lpszAddress参数为NULL,并且lpAutoDialEntries参数包含一个RASAUTODIALENTRY条目,该函数设置其为默认连接。RASAUTODIALENTRY条目中指定的电话簿条目名称必须是已存在的,否则会返回ERROR_CANNOT_FIND_PHONEBOOK_ENTRY错误。
若lpszAddress参数是一个空字符串,并且lpAutoDialEntries参数指向的RASAUTODIALENTRY条目指定的连接名称为空字符串,则该函数删除默认连接。
在非域主机上,如果用户在设置默认连接时将lpAutoDialEntries指向的RASAUTODIALENTRY结构中的szEntry指定为”for-all-users”,则其设置为全局默认连接,其它名称则是设置用户默认连接。
如果一个连接被配置为全局默认连接,另一个被配置为用户默认连接,那么这两个连接的名称是可以相同的。如果lpAutoDialEntries参数指定的连接名称与全局或用户默认连接一样,则只有用户默认连接被设置。
系统支持
客户端最小支持 | Windows 2000 专业版 |
---|---|
服务端最小支持 | Windows 2000 Server |
Header | Ras.h |
Library | Rasapi32.lib |
DLL | Rasapi32.dll |
Unicode和ANSI名称 | RasSetAutodialAddressW(Unicode)和RasSetAutodialAddressA(ANSI) |