[New - Windows NT]
RasGetEntryProperties功能检索电话簿条目的属性。
DWORD RasGetEntryProperties(
LPTSTR 【lpszPhonebook】, | //指向电话簿文件的完整路径和文件名 |
LPTSTR 【lpszEntry】, | //指向条目名称的指针 |
LPRASENTRY 【lpRasEntry】, | //接收条目信息的缓冲区 |
LPDWORD 【lpdwEntryInfoSize】, | //大小(以字节为单位)的【lpRasEntry】缓冲区 |
LPBYTE 【lpbDeviceInfo】, | //缓冲区,接收特定于设备的配置信息 |
LPDWORD 【lpdwDeviceInfoSize】 | //大小(以字节为单位)的【lpbDeviceInfo】缓冲区 |
); |
参数
【lpszPhonebook】
Windows NT:指向指定电话簿(.PBK)文件的完整路径和文件名的以空值终止的字符串的指针。如果此参数为NULL,则该函数使用当前的默认电话簿文件。默认电话簿文件是用户在拨号网络对话框的用户首选项属性表中选择的文件。
【lpszEntry】
指向包含现有条目名称的以null结尾的字符串。如果指定一个空字符串“”,该函数将返回由【lpRasEntry】和【lpbDeviceInfo】参数指向的缓冲区中的默认值。
【lpRasEntry】
指向RASENTRY结构,然后是备用电话号码列表的附加字节(如果有)。该结构接收与【lpszEntry】参数指定的电话簿条目相关联的连接数据。在调用该函数之前,将结构的的dwSize成员设置为sizeof(RASENTRY)以标识结构的版本。此参数可以为NULL。
【lpdwEntryInfoSize】
指向包含【lpRasEntry】缓冲区大小(以字节为单位)的变量。在返回时,函数将此变量设置为所需的字节数。如果【lpRasEntry】参数为NULL,则此参数可以为NULL。
要确定所需的缓冲区大小,请将【lpRasEntry】设置为NULL并将* 【lpdwEntryInfoSize】设置为零。该函数返回* 【lpdwEntryInfoSize】中所需的缓冲区大小。
【lpbDeviceInfo】
指向接收设备特定配置信息的缓冲区。这是不透明的TAPI设备配置信息,您不应该直接操作。此参数可以为NULL。有关TAPI设备配置的更多信息,请参阅Win32 Telephony(TAPI)程序员参考。
【lpdwDeviceInfoSize】
指向包含【lpbDeviceInfo】参数指定的缓冲区大小(以字节为单位)的变量。在返回时,函数将此变量设置为所需的字节数。如果【lpbDeviceInfo】参数为NULL,则此参数可以为NULL。
要确定所需的缓冲区大小,请将RasGetEntryProperties设置为NULL并将* 【lpdwDeviceInfoSize】设置为零。该函数返回* 【lpdwDeviceInfoSize】中所需的缓冲区大小。
返回值
如果函数成功,返回值为零。
如果函数失败,则返回值可以是以下错误代码之一。
值 | 含义 |
ERROR_INVALID_PARAMETER | 该函数调用无效参数。 |
ERROR_BUFFER_INVALID | 【lpRasEntry】指定的地址或缓冲区无效。 |
ERROR_BUFFER_TOO_SMALL | 【lpdwEntryInfoSize】中指示的缓冲区大小太小。 |
ERROR_CANNOT_OPEN_PHONEBOOK | 电话簿已损坏或丢失组件。 |
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY | 电话簿条目不存在。 |
也可以看看