RasGetEntryPropertiesA 函式 (ras.h)

  • 發行項

RasGetEntryProperties 函式會擷取電話簿項目的屬性。

語法

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

參數

[in] unnamedParam1

Null 終止字串的指標，指定電話簿 (PBK) 檔案的完整路徑和檔名。 如果此參數為 NULL，函式會使用目前的默認電話簿檔案。 默認電話簿檔案是由使用者選取的 [撥號網络] 對話方塊之 [用戶喜好設定] 屬性表中的使用者所選取的檔案。

Windows Me/98/95： 此參數應一律為 NULL。 撥號網路功能會將電話簿專案儲存在登錄中，而不是儲存在電話簿檔案中。

[in] unnamedParam2

指定現有項目名稱之 Null 終止字串的指標。 如果指定空字串，函式會在 lpRasEntry 和 lpbDeviceInfo 參數所指向的緩衝區中傳回預設值。

[in, out] unnamedParam3

如果有其他電話號碼清單，則 為RASENTRY 結構的指標，後面接著其他位元組。

在輸出時，結構會接收與 lpszEntry 參數所指定電話簿專案相關聯的連線數據。

在輸入時，將 結構的 dwSize 成員設定為 sizeof (RASENTRY) ，以識別結構的版本。

此參數可以是 Null。

Windows Me/98 和 Windows 95 OSR2： Microsoft Layer for Unicode 不支援 RASENTRY 中的 dwAlternateOffset。

[in, out] unnamedParam4

輸入時，變數的指標會指定 lpRasEntry 緩衝區的大小，以位元組為單位。

在輸出時，此變數會收到所需的位元元組數目。

如果 lpRasEntry 參數為 NULL，這個參數可以是 NULL。

若要判斷所需的緩衝區大小，請呼叫 RasGetEntryProperties 並將 lpRasEntry 設為 NULL ，並將 *lpdwEntryInfoSize 設為零。 函式會傳回 *lpdwEntryInfoSize 中所需的緩衝區大小。

[out] unnamedParam5

不再使用此參數。 呼叫函式應該將此參數設定為 NULL。

Windows Me/98/95： 接收裝置特定組態信息的緩衝區指標。 請勿直接操作此不透明的 TAPI 裝置資訊。 如需 TAPI 裝置設定的詳細資訊，請參閱 PLATFORM SDK 中 TAPI 程式設計人員參考中的 lineGetDevConfig 函式。

此參數可以是 Null。

[in, out] unnamedParam6

不使用這個參數。 呼叫函式應該將此參數設定為 NULL。

Windows Me/98/95： 輸入時，變數的指標會指定 lpbDeviceInfo 參數所指定緩衝區的大小，以位元組為單位。

在輸出時，此變數會收到所需的位元元組數目。

如果 lpbDeviceInfo 參數 s NULL，這個參數可以是 NULL。

若要判斷所需的緩衝區大小，請呼叫 RasGetEntryProperties 並將 lpbDeviceInfo 設為 NULL ，並將 *lpdwDeviceInfoSize 設為零。 函式會傳回 *lpdwDeviceInfoSize 中所需的緩衝區大小。

傳回值

如果函式成功，傳回值會 ERROR_SUCCESS。

如果函式失敗，則傳回值是下列其中一個錯誤碼，或 來自路由和遠端訪問錯誤碼 或 Winerror.h 的值。

值 意義
ERROR_INVALID_PARAMETER
 函式是以無效的參數呼叫。
ERROR_INVALID_SIZE
 lpRasEntry 之 dwSize 成員的值太小。
ERROR_BUFFER_INVALID
 lpRasEntry 指定的位址或緩衝區無效。
ERROR_BUFFER_TOO_SMALL
 lpdwEntryInfoSize 中所指出的緩衝區大小太小。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 電話簿專案不存在，或電話簿檔案已損毀，且/或缺少元件。

備註

注意

ras.h 標頭會將 RasGetEntryProperties 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 ras.h
程式庫 Rasapi32.lib
Dll Rasapi32.dll

另請參閱

RASENTRY

RasSetEntryProperties

遠端訪問服務 (RAS) 概觀

遠端存取服務函式