RasGetSubEntryPropertiesA 函式 (ras.h)
RasGetSubEntryProperties 函式會擷取指定之電話簿專案子專案的相關信息。
語法
DWORD RasGetSubEntryPropertiesA(
[in] LPCSTR unnamedParam1,
[in] LPCSTR unnamedParam2,
[in] DWORD unnamedParam3,
[in, out] LPRASSUBENTRYA unnamedParam4,
[in, out] LPDWORD unnamedParam5,
[in] LPBYTE unnamedParam6,
[in] LPDWORD unnamedParam7
);
參數
[in] unnamedParam1
null終止字串的指標,指定電話簿檔案的完整路徑和檔名。 如果此參數 NULL,則函式會使用目前的預設電話簿檔案。 默認的電話簿檔案是使用者在 [撥號網络] 對話框中 [使用者 喜好設定] 屬性表中選取的默認電話簿檔案。
Windows Me/98/95:此參數一律 NULL。 撥號網路會將電話簿專案儲存在登錄中,而不是儲存在電話簿檔案中。
[in] unnamedParam2
null終止字串的指標,指定電話簿中現有項目的名稱。
[in] unnamedParam3
指定子項目的單一型索引。
[in, out] unnamedParam4
RASSUBENTRY 結構的指標,如果有其他電話號碼清單,後面接著其他位元組。
在輸出時,結構會接收指定子專案的相關信息。
在輸入時,dwSize 成員會指定結構的大小。 大小會識別 結構的版本。 使用 sizeof 取得此大小(RASSUBENTRY)。
此參數可以是 NULL
[in, out] unnamedParam5
變數的指標,指定 lpRasSubEntry 緩衝區的輸入大小,以位元組為單位。
在輸出中,變數會接收傳回的位元組數目,或緩衝區太小時所需的位元組數目。
如果 lpRasSubEntryNULL,這個參數就可以 NULL。
[in] unnamedParam6
TAPI 裝置組態區塊的指標。 此參數目前未使用。 呼叫端應該傳遞此參數 NULL。 如需 TAPI 裝置組態區塊的詳細資訊,請參閱 function lineGetDevConfig。
[in] unnamedParam7
指定 TAPI 裝置組態區塊大小的 DWORD 指標。 此參數目前未使用。 呼叫端應該傳遞此參數 NULL。
傳回值
如果函式成功,則傳回值會 ERROR_SUCCESS。
如果函式失敗,傳回值是下列其中一個錯誤碼,或來自 路由和遠端訪問錯誤碼的值 或 Winerror.h。
價值 | 意義 |
---|---|
|
函式是以無效的參數呼叫。 |
|
lpRasSubEntry 指定的位址或緩衝區無效。 |
|
lpRasSubEntry 緩衝區太小。 lpdwcb 變數會收到所需的緩衝區大小。 |
|
電話簿已損毀或遺失元件。 |
|
電話簿專案不存在。 |
言論
RAS 電話簿專案可以有零或多個子專案,每個子專案都是由裝置和電話號碼所組成。 具有多個子項目的電話簿專案可以設定為在撥入專案時,先撥打第一個可用或所有子專案。
使用 RasGetEntryProperties 函式來擷取包含電話簿專案子專案相關信息的 RASENTRY 結構。 dwSubEntries 成員表示子項目的數目,而 dwDialMode 成員表示撥號組態。
注意
ras.h 標頭會根據 UNICODE 預處理器常數的定義,將 RasGetSubEntryProperties 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
支援的最低伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | ras.h |
連結庫 | Rasapi32.lib |
DLL | Rasapi32.dll |