RasGetSubEntryPropertiesA 函数（ras.h）

项目
11/20/2024

RasGetSubEntryProperties 函数检索有关指定电话簿条目的子项的信息。

语法

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

参数

[in] unnamedParam1

指向 null终止字符串的指针，该字符串指定电话簿（PBK）文件的完整路径和文件名。如果此参数 NULL，则该函数使用当前的默认电话簿文件。默认电话簿文件是用户在 用户首选项拨号网络 对话框中选择的文件。

Windows Me/98/95：此参数应始终 NULL。拨号网络将电话簿条目存储在注册表中，而不是存储在电话簿文件中。

[in] unnamedParam2

指向 null-terminated 字符串的指针，该字符串指定电话簿中现有条目的名称。

[in] unnamedParam3

指定子项的一个基于索引。

[in, out] unnamedParam4

指向 RASSUBENTRY 结构的指针，后跟备用电话号码列表的其他字节（如果有）。

在输出中，结构接收有关指定子项的信息。

在输入时，dwSize 成员指定结构的大小。大小标识结构的版本。使用 sizeof（RASSUBENTRY）获取此大小。

此参数可以 NULL。

[in, out] unnamedParam5

指向一个变量的指针，该变量指定 lpRasSubEntry 缓冲区的大小（以字节为单位）。

在输出中，变量接收返回的字节数，或缓冲区太小时所需的字节数。

如果 lpRasSubEntryNULL，则可以 NULL 此参数。

[in] unnamedParam6

指向 TAPI 设备配置块的指针。此参数当前未使用。调用方应为此参数传递 NULL。有关 TAPI 设备配置块的详细信息，请参阅 function lineGetDevConfig。

[in] unnamedParam7

指向指定 TAPI 设备配置块大小的 DWORD 的指针。此参数当前未使用。调用方应为此参数传递 NULL。

返回值

如果函数成功，则返回值 ERROR_SUCCESS。

如果函数失败，则返回值是以下错误代码之一或来自路由和远程访问错误代码或 Winerror.h 的值。

价值	意义
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 成员指示拨号配置。

注意

ras.h 标头将 RasGetSubEntryProperties 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。有关详细信息，请参阅函数原型的约定。

要求

要求	价值
最低支持的客户端	Windows 2000 Professional [仅限桌面应用]
支持的最低服务器	Windows 2000 Server [仅限桌面应用]
目标平台	窗户
标头	ras.h
库	Rasapi32.lib
DLL	Rasapi32.dll