RasSetEntryPropertiesA 函数 (ras.h)

项目
08/25/2023

RasSetEntryProperties 函数更改电话簿中某个条目的连接信息或创建新的电话簿条目。

语法

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

参数

[in] unnamedParam1

指向以 null 结尾的字符串的指针，该字符串指定电话簿 (PBK) 文件的完整路径和文件名。如果此参数为 NULL，则该函数使用当前默认电话簿文件。默认电话簿文件是用户在“拨号网络”对话框的“用户首选项”属性表中选择的电话簿文件。

[in] unnamedParam2

指向以 null 结尾的字符串的指针，该字符串指定条目名称。

如果条目名称与现有条目匹配， RasSetEntryProperties 将修改该条目的属性。

如果条目名称与现有条目不匹配， RasSetEntryProperties 将创建新的电话簿条目。对于新条目，请在调用 RasSetEntryProperties 之前调用 RasValidateEntryName 函数来验证条目名称。

[in] unnamedParam3

指向 RASENTRY 结构的指针，该结构指定要与 lpszEntry 参数指示的电话簿条目关联的新连接数据。

调用方必须为 RASENTRY 结构中的以下成员提供值。

dwSize
szLocalPhoneNumber
szDeviceName
szDeviceType
dwFramingProtocol
dwfOptions
dwType

Windows XP 或更高版本：支持 dwType。

如果未为这些成员提供值， 则 RasSetEntryProperties 将失败并 ERROR_INVALID_PARAMETER。

该结构后跟一个以 null 结尾的备用电话号码字符串数组。最后一个字符串以两个连续的 null 字符结尾。 RASENTRY 结构的 dwAlternateOffset 成员包含与第一个字符串的偏移量。

[in] unnamedParam4

指定 由 lpRasEntry 参数标识的缓冲区的大小（以字节为单位）。

[in] unnamedParam5

指向指定特定于设备的配置信息的缓冲区的指针。这是不透明的 TAPI 设备配置信息。有关 TAPI 设备配置的详细信息，请参阅平台 SDK 中的电话应用程序编程接口 (TAPI) 中的 lineGetDevConfig 函数。

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

[in] unnamedParam6

指定 lpbDeviceInfo 缓冲区的大小（以字节为单位）。

Windowsxp： 此参数未使用。调用函数应将此参数设置为零。

返回值

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

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

值	含义
ERROR_ACCESS_DENIED	用户没有正确的权限。只有管理员才能完成此任务。
ERROR_BUFFER_INVALID	lpRasEntry 指定的地址或缓冲区无效。
ERROR_CANNOT_OPEN_PHONEBOOK	电话簿已损坏或缺少组件。
ERROR_INVALID_PARAMETER	lpRasEntry 参数指向的 RASENTRY 结构不包含足够的信息，或者电话簿中不存在指定的条目。请参阅 lpRasEntry 的说明，了解所需的信息。

注解

设置所有用户连接的属性时，如果呼叫应用程序为电话簿参数 lpszPhonebook 指定非 NULL 值，则电话簿文件必须位于所有用户应用程序数据路径下的电话簿目录中。若要获取电话簿文件的正确位置，请首先调用 CSIDL 值为 CSIDL_COMMON_APPDATA 的 SHGetFolderPath。 SHGetFolderPath 返回所有用户应用程序数据路径。将以下字符串追加到此路径：

Microsoft\Network\Connections\Pbk

组合路径是电话簿文件的正确位置。

注意在高于 Windows XP 的 Windows 版本中，可能不支持为 lpszPhonebook 参数指定非 NULL 值。

注意

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

要求

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