Win32 API 日本語リファレンス
ホーム › Devices.Fax › IFaxOutgoingQueue

IFaxOutgoingQueue

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID80b1df24-d9ac-4333-b373-487cedc80ce5継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxOutgoingQueue インターフェースは、FAX クライアント アプリケーションが FAX サーバー上の送信 FAX キューの構成パラメーターを設定および取得するために使用する FaxOutgoingQueue 構成オブジェクトを定義します。

解説(Remarks)

IFaxOutgoingQueue の既定の実装は、FaxOutgoingQueue オブジェクトとして提供されます。

メソッド 24

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

vtbl 7 HRESULT get_Blocked(VARIANT_BOOL* pbBlocked)

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

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

解説(Remarks)

このプロパティが TRUE の場合、送信ジョブ キューはブロックされており、FAX サービスは送信 FAX の登録を受け付けません。このプロパティが FALSE の場合、キューはブロックされていません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 8 HRESULT put_Blocked(VARIANT_BOOL bBlocked)

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

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

解説(Remarks)

このプロパティが TRUE の場合、送信ジョブ キューはブロックされており、FAX サービスは送信 FAX の登録を受け付けません。このプロパティが FALSE の場合、キューはブロックされていません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 9 HRESULT get_Paused(VARIANT_BOOL* pbPaused)

IFaxOutgoingQueue::get_Paused プロパティは、送信 FAX のジョブ キューが一時停止しているかどうかを示すブール値です。(Get)

pbPausedVARIANT_BOOL*out送信キューが一時停止状態かを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、ジョブ キューは一時停止しており、FAX サービスはキュー内のジョブを処理しません。このプロパティが FALSE の場合、送信キューは一時停止していません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 10 HRESULT put_Paused(VARIANT_BOOL bPaused)

IFaxOutgoingQueue::get_Paused プロパティは、送信 FAX のジョブ キューが一時停止しているかどうかを示すブール値です。(Put)

bPausedVARIANT_BOOLin送信キューの一時停止状態を設定するVARIANT_BOOL。VARIANT_TRUEで一時停止。

解説(Remarks)

このプロパティが TRUE の場合、ジョブ キューは一時停止しており、FAX サービスはキュー内のジョブを処理しません。このプロパティが FALSE の場合、送信キューは一時停止していません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 11 HRESULT get_AllowPersonalCoverPages(VARIANT_BOOL* pbAllowPersonalCoverPages)

AllowPersonalCoverPages プロパティは、FAX クライアント アプリケーションが FAX 送信にユーザー作成のカバー ページを含めることができるかどうかを示すブール値です。(Get)

pbAllowPersonalCoverPagesVARIANT_BOOL*out個人用カバーページの使用が許可されているかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、クライアントは FAX 送信に個人用のカバー ページ ファイルを含めることができます。このプロパティが FALSE の場合、クライアントは FAX サーバーに保存されている共通のカバー ページ ファイルを使用する必要があります。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 12 HRESULT put_AllowPersonalCoverPages(VARIANT_BOOL bAllowPersonalCoverPages)

AllowPersonalCoverPages プロパティは、FAX クライアント アプリケーションが FAX 送信にユーザー作成のカバー ページを含めることができるかどうかを示すブール値です。(Put)

bAllowPersonalCoverPagesVARIANT_BOOLin個人用カバーページの使用許可を設定するVARIANT_BOOL。

解説(Remarks)

このプロパティが TRUE の場合、クライアントは FAX 送信に個人用のカバー ページ ファイルを含めることができます。このプロパティが FALSE の場合、クライアントは FAX サーバーに保存されている共通のカバー ページ ファイルを使用する必要があります。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 13 HRESULT get_UseDeviceTSID(VARIANT_BOOL* pbUseDeviceTSID)

IFaxOutgoingQueue::get_UseDeviceTSID プロパティは、FAX サービスが送信者の TSID ではなくデバイスの送信局識別子 (TSID) を使用するかどうかを示すブール値です。(Get)

pbUseDeviceTSIDVARIANT_BOOL*outデバイス側のTSID(送信局識別)を使用するかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスはユーザー指定の TSID ではなくデバイスの TSID を使用します。このプロパティが FALSE の場合、FAX サービスはユーザー指定の TSID を使用します。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 14 HRESULT put_UseDeviceTSID(VARIANT_BOOL bUseDeviceTSID)

IFaxOutgoingQueue::get_UseDeviceTSID プロパティは、FAX サービスが送信者の TSID ではなくデバイスの送信局識別子 (TSID) を使用するかどうかを示すブール値です。(Put)

bUseDeviceTSIDVARIANT_BOOLinデバイス側のTSIDを使用するかを設定するVARIANT_BOOL。VARIANT_TRUEで使用する。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスはユーザー指定の TSID ではなくデバイスの TSID を使用します。このプロパティが FALSE の場合、FAX サービスはユーザー指定の TSID を使用します。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 15 HRESULT get_Retries(INT* plRetries)

IFaxOutgoingQueue::get_Retries プロパティは、最初の送信が失敗したときに FAX サービスが送信 FAX の再送信を試行する回数を示す値です。(Get)

plRetriesINT*out送信失敗時の再試行回数を受け取るINTポインタ。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 16 HRESULT put_Retries(INT lRetries)

IFaxOutgoingQueue::get_Retries プロパティは、最初の送信が失敗したときに FAX サービスが送信 FAX の再送信を試行する回数を示す値です。(Put)

lRetriesINTin送信失敗時の再試行回数を設定するINT。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 17 HRESULT get_RetryDelay(INT* plRetryDelay)

IFaxOutgoingQueue::get_RetryDelay プロパティは、FAX サービスが送信 FAX ジョブの再送信を試行するまでに待機する時間間隔 (分単位) を示す値です。(Get)

plRetryDelayINT*out再試行間の待機時間(分単位)を受け取るINTポインタ。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 18 HRESULT put_RetryDelay(INT lRetryDelay)

IFaxOutgoingQueue::get_RetryDelay プロパティは、FAX サービスが送信 FAX ジョブの再送信を試行するまでに待機する時間間隔 (分単位) を示す値です。(Put)

lRetryDelayINTin再試行間の待機時間(分単位)を設定するINT。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 19 HRESULT get_DiscountRateStart(DOUBLE* pdateDiscountRateStart)

IFaxOutgoingQueue::get_DiscountRateStart プロパティは、FAX 送信の割引期間が開始する時刻を示す値です。割引期間は送信 FAX に適用されます。(Get)

pdateDiscountRateStartDOUBLE*out割引料金時間帯の開始時刻をDATE形式(OLEオートメーション日時)で受け取るDOUBLEポインタ。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 20 HRESULT put_DiscountRateStart(DOUBLE dateDiscountRateStart)

IFaxOutgoingQueue::get_DiscountRateStart プロパティは、FAX 送信の割引期間が開始する時刻を示す値です。割引期間は送信 FAX に適用されます。(Put)

dateDiscountRateStartDOUBLEin割引料金時間帯の開始時刻をDATE形式で設定するDOUBLE。時刻部のみ有効。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 21 HRESULT get_DiscountRateEnd(DOUBLE* pdateDiscountRateEnd)

IFaxOutgoingQueue::get_DiscountRateEnd プロパティは、FAX 送信の割引期間が終了する時刻を示す値です。割引期間は送信 FAX に適用されます。(Get)

pdateDiscountRateEndDOUBLE*out割引料金時間帯の終了時刻をDATE形式で受け取るDOUBLEポインタ。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 22 HRESULT put_DiscountRateEnd(DOUBLE dateDiscountRateEnd)

IFaxOutgoingQueue::get_DiscountRateEnd プロパティは、FAX 送信の割引期間が終了する時刻を示す値です。割引期間は送信 FAX に適用されます。(Put)

dateDiscountRateEndDOUBLEin割引料金時間帯の終了時刻をDATE形式で設定するDOUBLE。時刻部のみ有効。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 23 HRESULT get_AgeLimit(INT* plAgeLimit)

IFaxOutgoingQueue::get_AgeLimit プロパティは、未送信のジョブを FAX サービスが FAX ジョブ キューに保持する日数を示す値です。(Get)

plAgeLimitINT*out送信キュー内ジョブの保持上限日数を受け取るINTポインタ。0は無制限を意味する。

解説(Remarks)

FAX ジョブが指定された値よりも長く送信ジョブ キューに残っている場合、FAX サービスはそのジョブを削除します。このプロパティの値が 0 の場合、FAX サービスは保持期間の制限を適用しません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 24 HRESULT put_AgeLimit(INT lAgeLimit)

IFaxOutgoingQueue::get_AgeLimit プロパティは、未送信のジョブを FAX サービスが FAX ジョブ キューに保持する日数を示す値です。(Put)

lAgeLimitINTin送信キュー内ジョブの保持上限日数を設定するINT。0は無制限を意味する。

解説(Remarks)

FAX ジョブが指定された値よりも長く送信ジョブ キューに残っている場合、FAX サービスはそのジョブを削除します。このプロパティの値が 0 の場合、FAX サービスは保持期間の制限を適用しません。

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 25 HRESULT get_Branding(VARIANT_BOOL* pbBranding)

IFaxOutgoingQueue::get_Branding プロパティは、FAX サービスが送信 FAX の上部にブランド (バナー) を生成するかどうかを示すブール値です。(Get)

pbBrandingVARIANT_BOOL*out送信ファクス上端にブランド(送信元情報)行を付加するかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 26 HRESULT put_Branding(VARIANT_BOOL bBranding)

IFaxOutgoingQueue::get_Branding プロパティは、FAX サービスが送信 FAX の上部にブランド (バナー) を生成するかどうかを示すブール値です。(Put)

bBrandingVARIANT_BOOLin送信ファクスにブランド行を付加するかを設定するVARIANT_BOOL。

解説(Remarks)

このプロパティを読み取るか書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 27 HRESULT Refresh()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 28 HRESULT Save()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 29 HRESULT GetJobs(IFaxOutgoingJobs** pFaxOutgoingJobs)

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

pFaxOutgoingJobsIFaxOutgoingJobs**outFaxOutgoingJobs オブジェクトです。

戻り値

型: HRESULT

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

解説(Remarks)

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

farSUBMIT_LOW アクセス権の場合、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farQUERY_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

vtbl 30 HRESULT GetJob(LPWSTR bstrJobId, IFaxOutgoingJob** pFaxOutgoingJob)

IFaxOutgoingQueue::GetJob メソッドは、ジョブ キュー内の送信 FAX ジョブを ID に基づいて返します。

bstrJobIdLPWSTRinジョブ ID を指定します。
pFaxOutgoingJobIFaxOutgoingJob**outFaxOutgoingJob オブジェクトを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

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

farSUBMIT_LOW アクセス権の場合、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farQUERY_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxOutgoingQueue "{80B1DF24-D9AC-4333-B373-487CEDC80CE5}"
#usecom global IFaxOutgoingQueue IID_IFaxOutgoingQueue "{}"
#comfunc global IFaxOutgoingQueue_get_Blocked                  7 var
#comfunc global IFaxOutgoingQueue_put_Blocked                  8 int
#comfunc global IFaxOutgoingQueue_get_Paused                   9 var
#comfunc global IFaxOutgoingQueue_put_Paused                   10 int
#comfunc global IFaxOutgoingQueue_get_AllowPersonalCoverPages  11 var
#comfunc global IFaxOutgoingQueue_put_AllowPersonalCoverPages  12 int
#comfunc global IFaxOutgoingQueue_get_UseDeviceTSID            13 var
#comfunc global IFaxOutgoingQueue_put_UseDeviceTSID            14 int
#comfunc global IFaxOutgoingQueue_get_Retries                  15 var
#comfunc global IFaxOutgoingQueue_put_Retries                  16 int
#comfunc global IFaxOutgoingQueue_get_RetryDelay               17 var
#comfunc global IFaxOutgoingQueue_put_RetryDelay               18 int
#comfunc global IFaxOutgoingQueue_get_DiscountRateStart        19 var
#comfunc global IFaxOutgoingQueue_put_DiscountRateStart        20 double
#comfunc global IFaxOutgoingQueue_get_DiscountRateEnd          21 var
#comfunc global IFaxOutgoingQueue_put_DiscountRateEnd          22 double
#comfunc global IFaxOutgoingQueue_get_AgeLimit                 23 var
#comfunc global IFaxOutgoingQueue_put_AgeLimit                 24 int
#comfunc global IFaxOutgoingQueue_get_Branding                 25 var
#comfunc global IFaxOutgoingQueue_put_Branding                 26 int
#comfunc global IFaxOutgoingQueue_Refresh                      27
#comfunc global IFaxOutgoingQueue_Save                         28
#comfunc global IFaxOutgoingQueue_GetJobs                      29 sptr
#comfunc global IFaxOutgoingQueue_GetJob                       30 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。