DWORD RasGetEntryProperties(
_In_ LPCTSTR lpszPhonebook,
_In_ LPCTSTR lpszEntry,
_Inout_ LPRASENTRY lpRasEntry,
_Inout_ LPDWORD lpdwEntryInfoSize,
_Out_ LPBYTE lpbDeviceInfo,
_Inout_ LPDWORD lpdwDeviceInfoSize
);
说明
该函数用于获取电话簿条目属性。
参数
lpszPhonebook [in]
指向一个包含完整路径的电话簿文件(PBK)。如果参数为空,则该函数使用默认的电话簿文件。默认的电话簿文件由用户在拨号网络对话框的[user preferences]属性窗口中选择。
Windows Me/98/95: 该参数应为NULL,因为拨号网络将电话簿条目存储在注册表中。
lpszEntry [in]
指定电话簿条目名称。如果传入一个空字符串,那么将在lpRasEntry和lpbDeviceInfo参数中返回默认值。
lpRasEntry [in, out]
指向RASENTRY结构缓冲,结构末尾包含附加字节用于存储电话号码表。
该参数用于接收与lpszEntry参数指定的电话簿条目关联的连接数据。
调用前应将结构中的dwSize成员设置为sizeof(RASENTRY)。
该参数可以为NULL。
Windows Me/98 and Windows 95 OSR2: Microsoft Layer for Unicode不支持RASENTRY->dwAlternateOffset成员。
lpdwEntryInfoSize [in, out]
指向一个DWORD变量,用于指示lpRasEntry参数指向的缓冲字节数。或者是用于接收lpRasEntry参数需要分配的缓冲字节数。
如果lpRasEntry参数为NULL,则该参数可以为NULL。
设置lpRasEntry参数为NULL,并且将lpdwEntryInfoSize指向的变量设置为0,函数返回时会设置该变量为实际需要的缓冲字节数。
lpbDeviceInfo [out]
该参数已废弃,应传入NULL值。
Windows Me/98/95: 指向一个缓冲用于接收设备专用的配置信息。不能直接操作这个不透明的TAPI设备信息。查看lineGetDevConfig函数以获取更多关于TAPI设备配置信息。
该参数可以为NULL。
lpdwDeviceInfoSize [in, out]
该参数已被废弃,应传入NULL值。
Windows Me/98/95: 指向一个变量,用于指示lpDeviceInfo指向的缓冲字节数。或者用于接收需要为lpDeviceInfo指向的缓冲分配的字节数。
如果lpbDeviceInfo为NULL,则该参数可以为NULL。
设置lpbDeviceInfo参数为NULL,并且将lpdwDeviceInfoSize指向的变量设置为0,函数返回时会设置该变量为实际需要的缓冲字节数。
返回值
成功时返回ERROR_SUCCESS。
失败时返回以下列表中的值之一或来自Routing and Remote Access Error Codes或Winerror.h中定义的错误码。
值 | 含义 |
---|---|
RROR_INVALID_PARAMETER | 传入参数无效。 |
ERROR_INVALID_SIZE | lpRasEntry->dwSize的值不正确。 |
ERROR_BUFFER_INVALID | lpRasEntry指向的缓冲地址无效。 |
ERROR_BUFFER_TOO_SMALL | lpdwEntryInfoSize指示的缓冲长度太小。 |
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY | 找不到指定的电话簿条目。 |
系统支持
客户端最小支持 | Windows 2000专业版 |
---|---|
服务端最小支持 | Windows 2000 Server |
Header | Ras.h |
Library | Rasapi32.lib |
DLL | Rasapi32.dll |
Unicode和ANSI名称 | RasGetEntryPropertiesW(Unicode)和RasGetEntryPropertiesA(ANSI) |