RasGetSubEntryProperties

DWORD RasGetSubEntryProperties(
  _In_    LPCTSTR       lpszPhonebook,
  _In_    LPCTSTR       lpszEntry,
  _In_    DWORD         dwSubEntry,
  _Inout_ LPRASSUBENTRY lpRasSubEntry,
  _Inout_ LPDWORD       lpdwcb,
  _In_    LPBYTE        lpbDeviceConfig,
  _In_    LPDWORD       lpcbDeviceConfig
);

说明

该函数用于获取电话簿条目中的子条目信息。

参数

lpszPhonebook [in]

指向一个包含完整路径的电话簿文件(PBK)。如果参数为空，则该函数使用默认的电话簿文件。默认的电话簿文件由用户在拨号网络对话框的[user preferences]属性窗口中选择。

Windows Me/98/95: 该参数应为NULL,因为拨号网络将电话簿条目存储在注册表中。

lpszEntry [in]

指定电话簿条目名称。

dwSubEntry [in]

指定子条目索引，从1开始。

lpRasSubEntry [in, out]

指向一个RASSUBENTRY结构的缓冲用于接收指定子条目信息，结构末尾包含额外的多个字节用于存储备用号码列表。调用前将lpRasSubEntry->dwSize成员的值设置为sizeof(RASSUBENTRY)。

该参数可以为NULL。

lpdwcb [in, out]

指向一个变量，用于指示lpRasSubEntry指向的缓冲字节数。当lpRasSubEntry指向的缓冲长度不足时，函数设置该变量为实际需要的字节数。

当lpRasSubEntry参数为NULL时，该参数可以为NULL。

lpbDeviceConfig [in]

指向一个TAPI设备配置块缓冲。该参数目前并未使用，应传递NULL值。

返回值

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

值	含义
ERROR_INVALID_PARAMETER	参数错误。
ERROR_BUFFER_INVALID	lpRasSubEntry指向的缓冲无效。
ERROR_BUFFER_TOO_SMALL	lpRasSubEntry指向的缓冲长度不足。
ERROR_CANNOT_OPEN_PHONEBOOK	电话簿文件损坏或组件丢失。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	指定的电话簿条目不存在。

注意事项

一个RAS电话簿条目包含0个或多个子条目，每个子条目至少包含一个电话号码。拥有多个子条目的电话簿条目可以配置为只拨第一个号码或者所有号码。

系统支持

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