[New - Windows NT]
RasGetSubEntryProperties功能检索有关指定电话簿条目的子条目的信息。
DWORD RasGetSubEntryProperties(
LPTSTR 【lpszPhonebook】, | //指向电话簿文件的完整路径和文件名 |
LPTSTR 【lpszEntry】, | //指向条目名称的指针 |
DWORD 【dwSubEntry】, | //子条目的索引 |
LPRASSUBENTRY 【lpRasSubEntry】, | //指向接收有关子条目信息的结构体的指针 |
LPDWORD 【lpdwcb】 | //结构的大小(以字节为单位) |
); |
参数
【lpszPhonebook】
Windows NT:指向指定电话簿(.PBK)文件的完整路径和文件名的以空值终止的字符串的指针。如果此参数为NULL,则该函数使用当前的默认电话簿文件。默认电话簿文件是用户在拨号网络对话框的用户首选项属性表中选择的文件。
【lpszEntry】
指向一个以空字符结尾的字符串,其中包含电话簿中现有条目的名称。
【dwSubEntry】
指定子条目的基于索引的索引。
【lpRasSubEntry】
指向RASSUBENTRY结构,然后是备用电话号码列表的附加字节(如果有)。结构接收有关指定子条目的信息。在调用该函数之前,将结构的的dwSize成员设置为sizeof(RASSUBENTRY)以标识结构的版本。此参数可以为NULL。
【lpdwcb】
指向包含【lpRasSubEntry】缓冲区大小(以字节为单位)的变量。返回时,函数将此变量设置为返回的字节数,或缓冲区太小时所需的字节数。如果【lpRasSubEntry】为NULL,则此参数可以为NULL。
返回值
如果函数成功,返回值为零。
如果函数失败,则返回值可以是以下错误代码之一。
值 | 含义 |
ERROR_INVALID_PARAMETER | 该函数调用无效参数。 |
ERROR_BUFFER_INVALID | 【lpRasSubEntry】指定的地址或缓冲区无效。 |
ERROR_BUFFER_TOO_SMALL | 【lpRasSubEntry】缓冲区太小。【lpdwcb】变量接收所需的缓冲区大小。 |
ERROR_CANNOT_OPEN_PHONEBOOK | 电话簿已损坏或丢失组件。 |
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY | 电话簿条目不存在。 |
备注
RAS电话簿条目可以具有零个或多个子条目,每个子条目最少由设备和电话号码组成。具有多个子条目的电话簿条目可配置为在拨打条目时拨打第一个可用或所有子条目。
使用RasGetEntryProperties函数检索包含电话簿条目子条目信息的RASENTRY结构。dwSubEntries成员表示子条目数,dwDialMode成员表示拨号配置。
也可以看看
RasGetEntryProperties, RASENTRY, RasSetSubEntryProperties, RASSUBENTRY