通过

RasGetEntryPropertiesA 函数 （ras.h）

  • 项目

RasGetEntryProperties 函数检索电话簿条目的属性。

语法

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

参数

[in] unnamedParam1

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

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

[in] unnamedParam2

指向指定现有条目名称的 null终止字符串的指针。 如果指定了空字符串，该函数将返回由 lpRasEntry 指向的缓冲区中的默认值，并 lpbDeviceInfo 参数。

[in, out] unnamedParam3

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

输出时，结构接收与 lpszEntry 参数指定的电话簿条目关联的连接数据。

在输入时，将结构的 dwSize 成员设置为 sizeof（RASENTRY），以标识结构的版本。

此参数可以 NULL。

Windows Me/98 和 Windows 95 OSR2：Unicode 的 Microsoft 层不支持 RASENTRY中的 dwAlternateOffset。

[in, out] unnamedParam4

指向在输入上指定 lpRasEntry 缓冲区的大小（以字节为单位）的变量的指针。

在输出中，此变量接收所需的字节数。

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

若要确定所需的缓冲区大小，请调用 RasGetEntryProperties，并将 lpRasEntry 设置为 NULL，*lpdwEntryInfoSize 设置为零。 该函数返回 *lpdwEntryInfoSize中所需的缓冲区大小。

[out] unnamedParam5

不再使用此参数。 调用函数应将此参数设置为 NULL。

Windows Me/98/95：指向接收特定于设备的配置信息的缓冲区的指针。 请勿直接操作此不透明的 TAPI 设备信息。 有关 TAPI 设备配置的详细信息，请参阅 PLATFORM SDK 中的 TAPI 程序员参考中的 lineGetDevConfig 函数。

此参数可以 NULL。

[in, out] unnamedParam6

此参数未使用。 调用函数应将此参数设置为 NULL。

Windows Me/98/95：指向输入中指定由 lpbDeviceInfo 参数指定的缓冲区的大小（以字节为单位）的变量的指针。

在输出中，此变量接收所需的字节数。

如果 lpbDeviceInfo 参数 NULL，则可以将此参数 NULL。

若要确定所需的缓冲区大小，请调用 RasGetEntryProperties，并将 lpbDeviceInfo 设置为 NULL，*lpdwDeviceInfoSize 设置为零。 该函数返回 *lpdwDeviceInfoSize中所需的缓冲区大小。

返回值

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

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

价值 意义
ERROR_INVALID_PARAMETER
 该函数是使用无效参数调用的。
ERROR_INVALID_SIZE
 lpRasEntry 的 dwSize 成员的值太小。
ERROR_BUFFER_INVALID
 lpRasEntry 指定的地址或缓冲区无效。
ERROR_BUFFER_TOO_SMALL
 lpdwEntryInfoSize 中指示的缓冲区大小太小。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 电话簿条目不存在，或者电话簿文件已损坏且/或缺少组件。

言论

注意

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

要求

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

另请参阅

RASENTRY

RasSetEntryProperties

远程访问服务（RAS）概述

远程访问服务函数