DWORD RasSetSubEntryProperties(
_In_ LPCTSTR lpszPhonebook,
_In_ LPCTSTR lpszEntry,
_In_ DWORD dwSubEntry,
_In_ LPRASSUBENTRY lpRasSubEntry,
_In_ DWORD dwcbRasSubEntry,
_In_ LPBYTE lpbDeviceConfig,
_In_ DWORD dwcbDeviceConfig
);
说明
该函数用于为指定的电话簿条目创建子条目或修改子条目信息。
参数
lpszPhonebook [in]
指向一个包含完整路径的电话簿文件(PBK)。如果参数为空,则该函数使用默认的电话簿文件。默认的电话簿文件由用户在拨号网络对话框的[user preferences]属性窗口中选择。
Windows Me/98/95: 该参数应为NULL,因为拨号网络将电话簿条目存储在注册表中。
lpszEntry [in]
指定一个已存在的电话簿条目名称。
dwSubEntry [in]
指定子条目索引(从1开始)。如果存在则修改子条目属性,否则添加子条目。
lpRasSubEntry [in]
指向一个包含子条目数据的RASSUBENTRY结构。
该结构末尾可能紧随多个电话号码字符串。每个号码串以null结束,最后一个号码串以两个null结束。lpRasSubEntry->dwAlternateOffset成员指示第一个字符串的起始位置。
dwcbRasSubEntry [in]
指示lpRasSubEntry参数指向的缓冲长度字节数。
lpbDeviceConfig [in]
指向一个TAPI设备配置块。该参数当前未使用,必须传递NULL。更多关于TAPI设备配置块的信息,可以参考函数lineGetDevConfig。
dwcbDeviceConfig [in]
指示lpbDeviceConfig参数指向的缓冲长度字节数。该参数当前未使用,必须传递0。
返回值
成功时返回ERROR_SUCCESS。
失败时返回以下列表中的值之一或来自Routing and Remote Access Error Codes或Winerror.h中定义的错误码。
值 | 含义 |
---|---|
ERROR_BUFFER_INVALID | lpRasEntry参数指向的缓冲无效。 |
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY | 指定的电话簿条目不存在。 |
ERROR_CANNOT_OPEN_PHONEBOOK | 电话簿文件损坏或组件丢失。 |
ERROR_INVALID_PARAMETER | 参数错误。 |
注意事项
一个RAS电话簿条目包含0个或多个子条目,每个子条目至少包含一个电话号码。拥有多个子条目的电话簿条目可以配置为只拨第一个号码或者所有号码。
使用RasGetEntryProperties函数获取包含电话簿条目的子条目信息的RASENTRY结构,该结构的dwSubEntries成员指出子条目数量,dwDialMode成员指示拨号模式。
系统支持
客户端最小支持 | Windows 2000 专业版 |
---|---|
服务端最小支持 | Windows 2000 Server |
Header | Ras.h |
Library | Rasapi32.lib |
DLL | Rasapi32.dll |
Unicode和ANSI名称 | RasSetSubEntryPropertiesW(Unicode)和RasSetSubEntryPropertiesA(ANSI) |