RasGetSubEntryProperties

DWORD RasGetSubEntryProperties(
  _In_    LPCTSTR       lpszPhonebook,
  _In_    LPCTSTR       lpszEntry,
  _In_    DWORD         dwSubEntry,
  _Inout_ LPRASSUBENTRY lpRasSubEntry,
  _Inout_ LPDWORD       lpdwcb,
  _In_    LPBYTE        lpbDeviceConfig,
  _In_    LPDWORD       lpcbDeviceConfig
);
           

說明

該函數用于擷取電話簿條目中的子條目資訊。

參數

lpszPhonebook [in]

指向一個包含完整路徑的電話簿檔案(PBK)。如果參數為空，則該函數使用預設的電話簿檔案。預設的電話簿檔案由使用者在撥号網絡對話框的[user preferences]屬性視窗中選擇。

Windows Me/98/95: 該參數應為NULL,因為撥号網絡将電話簿條目存儲在系統資料庫中。

lpszEntry [in]

指定電話簿條目名稱。

dwSubEntry [in]

指定子條目索引，從1開始。

lpRasSubEntry [in, out]

指向一個RASSUBENTRY結構的緩沖用于接收指定子條目資訊，結構末尾包含額外的多個位元組用于存儲備用号碼清單。調用前将lpRasSubEntry->dwSize成員的值設定為sizeof(RASSUBENTRY)。

該參數可以為NULL。

lpdwcb [in, out]

指向一個變量，用于訓示lpRasSubEntry指向的緩沖位元組數。當lpRasSubEntry指向的緩沖長度不足時，函數設定該變量為實際需要的位元組數。

當lpRasSubEntry參數為NULL時，該參數可以為NULL。

lpbDeviceConfig [in]

指向一個TAPI裝置配置塊緩沖。該參數目前并未使用，應傳遞NULL值。

傳回值

成功時傳回ERROR_SUCCESS。

失敗時傳回以下清單中的值之一或來自Routing and Remote Access Error Codes或Winerror.h中定義的錯誤碼。

值	含義
ERROR_INVALID_PARAMETER	參數錯誤。
ERROR_BUFFER_INVALID	lpRasSubEntry指向的緩沖無效。
ERROR_BUFFER_TOO_SMALL	lpRasSubEntry指向的緩沖長度不足。
ERROR_CANNOT_OPEN_PHONEBOOK	電話簿檔案損壞或元件丢失。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	指定的電話簿條目不存在。

注意事項

一個RAS電話簿條目包含0個或多個子條目，每個子條目至少包含一個電話号碼。擁有多個子條目的電話簿條目可以配置為隻撥第一個号碼或者所有号碼。

系統支援

用戶端最小支援	Windows 2000 專業版
服務端最小支援	Windows 2000 Server
Header	Ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll
Unicode和ANSI名稱	RasGetSubEntryPropertiesW(Unicode)和RasGetSubEntryPropertiesA(ANSI)