IFaxIncomingQueue

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID902e64ef-8fd8-4b75-9725-6014df161545継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxIncomingQueue インターフェイスは、FAX クライアントアプリケーションがジョブキュー内の受信 FAX ジョブ (FaxIncomingJobs オブジェクト) を管理するために使用します。また、このオブジェクトには FAX ジョブキューへの受信 FAX をブロックするメソッドも含まれます。

解説(Remarks)

C++ で FaxIncomingQueue オブジェクトを作成するには、IFaxFolders::get_IncomingQueue メソッドを呼び出します。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Blocked(VARIANT_BOOL* pbBlocked)

Blocked プロパティは、受信 FAX のジョブキューがブロックされているかどうかを示すブール値です。(取得)

pbBlocked

VARIANT_BOOL*

out

受信キューがブロック(受信停止)状態かを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、受信ジョブキューはブロックされており、FAX サービスは着信 FAX 呼び出しに応答しません。このプロパティが FALSE の場合、キューはブロックされていません。

vtbl 8 HRESULT put_Blocked(VARIANT_BOOL bBlocked)

Blocked プロパティは、受信 FAX のジョブキューがブロックされているかどうかを示すブール値です。(設定)

bBlocked

VARIANT_BOOL

受信キューのブロック(受信停止)状態を設定するVARIANT_BOOL。VARIANT_TRUEで停止。

解説(Remarks)

vtbl 9 HRESULT Refresh()

Refresh メソッドは、FAX サーバーから FaxIncomingQueue オブジェクトの情報を更新します。Refresh メソッドを呼び出すと、最後に Save メソッドを呼び出した後に行われた構成の変更は失われます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 10 HRESULT Save()

Save メソッドは、FaxIncomingQueue オブジェクトのデータを保存します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 11 HRESULT GetJobs(IFaxIncomingJobs** pFaxIncomingJobs)

GetJobs メソッドは、キュー内の受信 FAX ジョブのコレクションを返します。

pFaxIncomingJobs

IFaxIncomingJobs**

out

FaxIncomingJobs オブジェクトです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farQUERY_JOBS および farSUBMIT_LOW アクセス権を持っている必要があります。

vtbl 12 HRESULT GetJob(LPWSTR bstrJobId, IFaxIncomingJob** pFaxIncomingJob)

GetJob メソッドは、ジョブキュー内の受信 FAX ジョブを ID に従って返します。

bstrJobId	LPWSTR	in	ジョブ ID を指定します。
pFaxIncomingJob	IFaxIncomingJob**	out	FaxIncomingJob オブジェクトです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farQUERY_JOBS および farSUBMIT_LOW アクセス権を持っている必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IFaxIncomingQueue "{902E64EF-8FD8-4B75-9725-6014DF161545}"
#usecom global IFaxIncomingQueue IID_IFaxIncomingQueue "{}"
#comfunc global IFaxIncomingQueue_get_Blocked  7 var
#comfunc global IFaxIncomingQueue_put_Blocked  8 int
#comfunc global IFaxIncomingQueue_Refresh      9
#comfunc global IFaxIncomingQueue_Save         10
#comfunc global IFaxIncomingQueue_GetJobs      11 sptr
#comfunc global IFaxIncomingQueue_GetJob       12 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFaxIncomingQueue "{902E64EF-8FD8-4B75-9725-6014DF161545}"
#usecom global IFaxIncomingQueue IID_IFaxIncomingQueue "{}"
#comfunc global IFaxIncomingQueue_get_Blocked  7 sptr
#comfunc global IFaxIncomingQueue_put_Blocked  8 int
#comfunc global IFaxIncomingQueue_Refresh      9
#comfunc global IFaxIncomingQueue_Save         10
#comfunc global IFaxIncomingQueue_GetJobs      11 sptr
#comfunc global IFaxIncomingQueue_GetJob       12 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。