RasGetEntryProperties

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)