FaxGetConfigurationW 函式 (winfax.h)
FaxGetConfiguration 函式會傳回傳真用戶端應用程式用戶端的全域組態設定,供用戶端連線的傳真伺服器。 數據包括其他專案、重新傳輸、商標、封存和封面設定;折扣率週期;和傳真伺服器佇列的狀態。
語法
WINFAXAPI BOOL FaxGetConfigurationW(
[in] HANDLE FaxHandle,
[out] PFAX_CONFIGURATIONW *FaxConfig
);
參數
[in] FaxHandle
類型:HANDLE
指定由呼叫 FaxConnectFaxServer 函式所傳回的傳真伺服器句柄。
[out] FaxConfig
類型:PFAX_CONFIGURATION*
要接收 FAX_CONFIGURATION 結構的緩衝區位址指標。 結構包含傳真伺服器的目前組態設定。 如需記憶體配置的相關信息,請參閱下列一節。
傳回值
類型:BOOL
如果函式成功,則傳回值為非零值。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 GetLastError 可以傳回下列其中一個錯誤。
傳回碼 | 描述 |
---|---|
|
一或兩個 FaxConfig 或 FaxHandle 參數都會 NULL。 |
|
拒絕存取。 需要 FAX_CONFIG_QUERY 存取權。 |
|
記憶體配置期間發生錯誤。 |
言論
傳真系統管理應用程式通常會呼叫 FaxGetConfiguration 函式,以顯示傳真伺服器的全域組態設定。 若要變更組態設定,請呼叫 FaxSetConfiguration 函式。
FaxGetConfiguration 函式會配置 FaxConfig 參數所指向之 FAX_CONFIGURATION 緩衝區所需的記憶體。 應用程式必須呼叫 FaxFreeBuffer 函式,以解除分配與此參數相關聯的資源。
如需詳細資訊,請參閱 傳真伺服器組態管理 和 釋放傳真資源。
注意
winfax.h 標頭會將 FaxGetConfiguration 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
支援的最低伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | winfax.h |
連結庫 | WinFax.lib |
另請參閱
適用於 Windows 2000 的