RasSetEntryProperties

DWORD RasSetEntryProperties(
  _In_ LPCTSTR    lpszPhonebook,
  _In_ LPCTSTR    lpszEntry,
  _In_ LPRASENTRY lpRasEntry,
  _In_ DWORD      dwEntryInfoSize,
  _In_ LPBYTE     lpbDeviceInfo,
  _In_ DWORD      dwDeviceInfoSize
);

说明

该函数用于创建一个电话簿条目或修改其属性。

参数

lpszPhonebook [in]

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

lpszEntry [in]

指定电话簿条目名称。

如果条目名称已存在，则修改其属性。如果不存在，则创建一个新条目。应在创建新条目前调用RasValidateEntryName函数以验证条目名称的有效性。

lpRasEntry [in]

指向一个RASENTRY结构，该结构包含连接相关数据。

该结构中的以下成员必须设置：

• dwSize
• szLocalPhoneNumber
• szDeviceName
• szDeviceType
• dwFramingProtocol
• dwfOptions
• dwType

Windows XP及以后版本: 支持dwType成员。

若以上成员值未全部提供，将返回ERROR_INVALID_PARAMETER错误。

该结构末尾可能紧随多个null结束的电话号码字符串，最后一个字符串以两个null字符结束。其中的dwAlternateOffset成员指示第一个号码字符串的起始位置。

dwEntryInfoSize [in]

指示lpRasEntry指向的缓冲长度字节数。

lpbDeviceInfo [in]

指向一个设备特定的配置信息缓冲。这是一个未公开的TAPI设备配置信息。更多关于TAPI设备配置信息可查看Telephony Application Programming Interfaces (TAPI)中的lineGetDevConfig函数。

Windows XP: 该参数未使用，应设置为NULL。

dwDeviceInfoSize [in]

指示lpbDeviceInfo参数指向的缓冲长度字节数。

Windows XP: 该参数未使用，应设置为0。

返回值

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

值	含义
ERROR_ACCESS_DENIED	仅管理员用户才能执行此函数。
ERROR_BUFFER_INVALID	lpRasEntry指向的缓冲无效。
ERROR_CANNOT_OPEN_PHONEBOOK	电话簿文件损坏或组件丢失。
ERROR_INVALID_PARAMETER	lpRasEntry参数指向的结构未能提供足够的参数数据，或者指定的电话簿条目不存在。

注意事项

设置所有用户连接时，如果lpszPhonebook参数不为空，则电话簿文件必须在all-users application data目录下。可以通过调用SHGetFolderPath函数并且传递CSIDL_COMMON_APPDATA值来获取all-users application data目录。然后附加以下路径：

Microsoft\Network\Connections\Pbk

最终结果即是正确的电话簿文件路径。

注意 Windows XP后期版本可能不再支持lpszPhonebook参数。

系统支持

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