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

IFaxConfiguration

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

公式ドキュメント

FAX サービスの構成オプションを提供するさまざまなメソッドを定義します。

解説(Remarks)

このインターフェースの既定の実装は FaxConfiguration オブジェクトによって提供されます。

メソッド 42

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

vtbl 7 HRESULT get_UseArchive(VARIANT_BOOL* pbUseArchive)

FAX をアーカイブするかどうかを示す値を設定または取得します。(Get)

pbUseArchiveVARIANT_BOOL*outファクスのアーカイブ機能が有効かを受け取るVARIANT_BOOLポインタ。
vtbl 8 HRESULT put_UseArchive(VARIANT_BOOL bUseArchive)

FAX をアーカイブするかどうかを示す値を設定または取得します。(Put)

bUseArchiveVARIANT_BOOLinファクスのアーカイブ機能の有効/無効を設定するVARIANT_BOOL。
vtbl 9 HRESULT get_ArchiveLocation(LPWSTR* pbstrArchiveLocation)

サーバー上のアーカイブの場所を示す値を設定または取得します。(Get)

pbstrArchiveLocationLPWSTR*outアーカイブの保存先フォルダパスを受け取るBSTRポインタ。
vtbl 10 HRESULT put_ArchiveLocation(LPWSTR bstrArchiveLocation)

サーバー上のアーカイブの場所を示す値を設定または取得します。(Put)

bstrArchiveLocationLPWSTRinアーカイブの保存先フォルダパスを設定するBSTR。
vtbl 11 HRESULT get_SizeQuotaWarning(VARIANT_BOOL* pbSizeQuotaWarning)

サイズクォータの警告が有効かどうかを示す値を設定または取得します。(Get)

pbSizeQuotaWarningVARIANT_BOOL*outアーカイブサイズ超過時の警告が有効かを受け取るVARIANT_BOOLポインタ。
vtbl 12 HRESULT put_SizeQuotaWarning(VARIANT_BOOL bSizeQuotaWarning)

サイズクォータの警告が有効かどうかを示す値を設定または取得します。(Put)

bSizeQuotaWarningVARIANT_BOOLinアーカイブサイズ超過時の警告の有効/無効を設定するVARIANT_BOOL。
vtbl 13 HRESULT get_HighQuotaWaterMark(INT* plHighQuotaWaterMark)

ウォーターマークに割り当てられる最大サイズを示す値を設定または取得します。(Get)

plHighQuotaWaterMarkINT*out警告を発する上限ウォーターマーク値(MB単位)を受け取るINTポインタ。
vtbl 14 HRESULT put_HighQuotaWaterMark(INT lHighQuotaWaterMark)

ウォーターマークに割り当てられる最大サイズを示す値を設定または取得します。(Put)

lHighQuotaWaterMarkINTin警告を発する上限ウォーターマーク値(MB単位)を設定するINT。
vtbl 15 HRESULT get_LowQuotaWaterMark(INT* plLowQuotaWaterMark)

ウォーターマークの最小サイズを示す値を設定または取得します。(Get)

plLowQuotaWaterMarkINT*out警告を解除する下限ウォーターマーク値(MB単位)を受け取るINTポインタ。
vtbl 16 HRESULT put_LowQuotaWaterMark(INT lLowQuotaWaterMark)

ウォーターマークの最小サイズを示す値を設定または取得します。(Put)

lLowQuotaWaterMarkINTin警告を解除する下限ウォーターマーク値(MB単位)を設定するINT。
vtbl 17 HRESULT get_ArchiveAgeLimit(INT* plArchiveAgeLimit)

FAX メッセージがサーバー上に保持される期間を示す値を設定または取得します。(Get)

plArchiveAgeLimitINT*outアーカイブの保持上限日数を受け取るINTポインタ。0は無制限を意味する。
vtbl 18 HRESULT put_ArchiveAgeLimit(INT lArchiveAgeLimit)

FAX メッセージがサーバー上に保持される期間を示す値を設定または取得します。(Put)

lArchiveAgeLimitINTinアーカイブの保持上限日数を設定するINT。0は無制限を意味する。
vtbl 19 HRESULT get_ArchiveSizeLow(INT* plSizeLow)

FAX メッセージアーカイブのサイズの下位 32 ビット値 (バイト単位) を指定する値です。

plSizeLowINT*outアーカイブ総サイズの下位32ビットをバイト単位で受け取るINTポインタ。

解説(Remarks)

アーカイブのサイズは 4 ギガバイト (GB) を超える可能性があるため、アーカイブサイズは 2 つの long 値で表されます。ArchiveSizeLow はアーカイブサイズの下位 32 ビット値です。ArchiveSizeHigh はアーカイブサイズの上位 32 ビット値です。アーカイブのサイズは次のようになります: ArchiveSizeLow + 4 GB * ArchiveSizeHigh。

ArchiveSizeLow プロパティと ArchiveSizeHigh プロパティの値が両方とも 0xffffffff の場合、それらは無効なアーカイブサイズを示しているため、両方のプロパティ値を無視してください。

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

vtbl 20 HRESULT get_ArchiveSizeHigh(INT* plSizeHigh)

FAX メッセージアーカイブのサイズの上位 32 ビット値 (バイト単位) を指定する値です。

plSizeHighINT*outアーカイブ総サイズの上位32ビットをバイト単位で受け取るINTポインタ。

解説(Remarks)

アーカイブのサイズは 4 ギガバイト (GB) を超える可能性があるため、アーカイブサイズは 2 つの long 値で表されます。ArchiveSizeLow はアーカイブサイズの下位 32 ビット値です。ArchiveSizeHigh はアーカイブサイズの上位 32 ビット値です。アーカイブのサイズは次のようになります: ArchiveSizeLow + 4 GB * ArchiveSizeHigh。

ArchiveSizeLow プロパティと ArchiveSizeHigh プロパティの値が両方とも 0xffffffff の場合、それらは無効なアーカイブサイズを示しているため、両方のプロパティ値を無視してください。

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

vtbl 21 HRESULT get_OutgoingQueueBlocked(VARIANT_BOOL* pbOutgoingBlocked)

送信 FAX 用の FAX サーバーキューがブロックされているかどうかを示す値を設定または取得します。(Get)

pbOutgoingBlockedVARIANT_BOOL*out送信キューがブロック状態かを受け取るVARIANT_BOOLポインタ。
vtbl 22 HRESULT put_OutgoingQueueBlocked(VARIANT_BOOL bOutgoingBlocked)

送信 FAX 用の FAX サーバーキューがブロックされているかどうかを示す値を設定または取得します。(Put)

bOutgoingBlockedVARIANT_BOOLin送信キューのブロック状態を設定するVARIANT_BOOL。VARIANT_TRUEで送信停止。
vtbl 23 HRESULT get_OutgoingQueuePaused(VARIANT_BOOL* pbOutgoingPaused)

送信キューが一時停止されているかどうかを示す値を設定または取得します。(Get)

pbOutgoingPausedVARIANT_BOOL*out送信キューが一時停止状態かを受け取るVARIANT_BOOLポインタ。
vtbl 24 HRESULT put_OutgoingQueuePaused(VARIANT_BOOL bOutgoingPaused)

送信キューが一時停止されているかどうかを示す値を設定または取得します。(Put)

bOutgoingPausedVARIANT_BOOLin送信キューの一時停止状態を設定するVARIANT_BOOL。
vtbl 25 HRESULT get_AllowPersonalCoverPages(VARIANT_BOOL* pbAllowPersonalCoverPages)

個人用カバーページが許可されているかどうかを示す値を設定または取得します。(Get)

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

個人用カバーページが許可されているかどうかを示す値を設定または取得します。(Put)

bAllowPersonalCoverPagesVARIANT_BOOLin個人用カバーページの使用許可を設定するVARIANT_BOOL。
vtbl 27 HRESULT get_UseDeviceTSID(VARIANT_BOOL* pbUseDeviceTSID)

送信局識別子 (TSID) を使用するかどうかを示す値を設定または取得します。(Get)

pbUseDeviceTSIDVARIANT_BOOL*outデバイス側のTSIDを使用するかを受け取るVARIANT_BOOLポインタ。
vtbl 28 HRESULT put_UseDeviceTSID(VARIANT_BOOL bUseDeviceTSID)

送信局識別子 (TSID) を使用するかどうかを示す値を設定または取得します。(Put)

bUseDeviceTSIDVARIANT_BOOLinデバイス側のTSIDを使用するかを設定するVARIANT_BOOL。
vtbl 29 HRESULT get_Retries(INT* plRetries)

指定した FAX ジョブのリダイヤル試行回数を示す値を設定または取得します。(Get)

plRetriesINT*out送信失敗時の再試行回数を受け取るINTポインタ。
vtbl 30 HRESULT put_Retries(INT lRetries)

指定した FAX ジョブのリダイヤル試行回数を示す値を設定または取得します。(Put)

lRetriesINTin送信失敗時の再試行回数を設定するINT。
vtbl 31 HRESULT get_RetryDelay(INT* plRetryDelay)

FAX 送信が失敗した後、FAX サービスが再試行するまでに待機する時間を示す値を設定または取得します。(Get)

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

FAX 送信が失敗した後、FAX サービスが再試行するまでに待機する時間を示す値を設定または取得します。(Put)

lRetryDelayINTin再試行間の待機時間(分単位)を設定するINT。
vtbl 33 HRESULT get_DiscountRateStart(DOUBLE* pdateDiscountRateStart)

割引料金時間帯が開始する時刻を示す値を設定または取得します。(Get)

pdateDiscountRateStartDOUBLE*out割引料金時間帯の開始時刻をDATE形式で受け取るDOUBLEポインタ。
vtbl 34 HRESULT put_DiscountRateStart(DOUBLE dateDiscountRateStart)

割引料金時間帯が開始する時刻を示す値を設定または取得します。(Put)

dateDiscountRateStartDOUBLEin割引料金時間帯の開始時刻をDATE形式で設定するDOUBLE。時刻部のみ有効。
vtbl 35 HRESULT get_DiscountRateEnd(DOUBLE* pdateDiscountRateEnd)

割引料金時間帯が終了する時刻を示す値を設定または取得します。(Get)

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

割引料金時間帯が終了する時刻を示す値を設定または取得します。(Put)

dateDiscountRateEndDOUBLEin割引料金時間帯の終了時刻をDATE形式で設定するDOUBLE。時刻部のみ有効。
vtbl 37 HRESULT get_OutgoingQueueAgeLimit(INT* plOutgoingQueueAgeLimit)

配信できなかった FAX メッセージが削除されるまで FAX サーバー上に保持される期間を示す値を設定または取得します。(Get)

plOutgoingQueueAgeLimitINT*out送信キュー内ジョブの保持上限日数を受け取るINTポインタ。0は無制限。
vtbl 38 HRESULT put_OutgoingQueueAgeLimit(INT lOutgoingQueueAgeLimit)

配信できなかった FAX メッセージが削除されるまで FAX サーバー上に保持される期間を示す値を設定または取得します。(Put)

lOutgoingQueueAgeLimitINTin送信キュー内ジョブの保持上限日数を設定するINT。0は無制限。
vtbl 39 HRESULT get_Branding(VARIANT_BOOL* pbBranding)

FAX サーバーが送信 FAX にブランディングマークを生成するかどうかを示す値を設定または取得します。(Get)

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

FAX サーバーが送信 FAX にブランディングマークを生成するかどうかを示す値を設定または取得します。(Put)

bBrandingVARIANT_BOOLin送信ファクスにブランド行を付加するかを設定するVARIANT_BOOL。
vtbl 41 HRESULT get_IncomingQueueBlocked(VARIANT_BOOL* pbIncomingBlocked)

受信 FAX 用の FAX サーバーキューがブロックされているかどうかを示す値を設定または取得します。(Get)

pbIncomingBlockedVARIANT_BOOL*out受信キューがブロック状態かを受け取るVARIANT_BOOLポインタ。
vtbl 42 HRESULT put_IncomingQueueBlocked(VARIANT_BOOL bIncomingBlocked)

受信 FAX 用の FAX サーバーキューがブロックされているかどうかを示す値を設定または取得します。(Put)

bIncomingBlockedVARIANT_BOOLin受信キューのブロック状態を設定するVARIANT_BOOL。VARIANT_TRUEで受信停止。
vtbl 43 HRESULT get_AutoCreateAccountOnConnect(VARIANT_BOOL* pbAutoCreateAccountOnConnect)

接続が開始されたときにサーバーが FAX アカウントを自動的に作成するかどうかを示す値を設定または取得します。(Get)

pbAutoCreateAccountOnConnectVARIANT_BOOL*out接続時にアカウントを自動作成するかを受け取るVARIANT_BOOLポインタ。
vtbl 44 HRESULT put_AutoCreateAccountOnConnect(VARIANT_BOOL bAutoCreateAccountOnConnect)

接続が開始されたときにサーバーが FAX アカウントを自動的に作成するかどうかを示す値を設定または取得します。(Put)

bAutoCreateAccountOnConnectVARIANT_BOOLin接続時にアカウントを自動作成するかを設定するVARIANT_BOOL。
vtbl 45 HRESULT get_IncomingFaxesArePublic(VARIANT_BOOL* pbIncomingFaxesArePublic)

受信 FAX を全員が表示できるか、それともプライベートであるかを示します。(Get)

pbIncomingFaxesArePublicVARIANT_BOOL*out受信ファクスを全ユーザーに公開するかを受け取るVARIANT_BOOLポインタ。
vtbl 46 HRESULT put_IncomingFaxesArePublic(VARIANT_BOOL bIncomingFaxesArePublic)

受信 FAX を全員が表示できるか、それともプライベートであるかを示します。(Put)

bIncomingFaxesArePublicVARIANT_BOOLin受信ファクスを全ユーザーに公開するかを設定するVARIANT_BOOL。
vtbl 47 HRESULT Refresh()

オブジェクトを更新します。

戻り値

このメソッドは値を返しません。

vtbl 48 HRESULT Save()

オブジェクトを保存します。

戻り値

型: HRESULT

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxConfiguration "{10F4D0F7-0994-4543-AB6E-506949128C40}"
#usecom global IFaxConfiguration IID_IFaxConfiguration "{}"
#comfunc global IFaxConfiguration_get_UseArchive                  7 var
#comfunc global IFaxConfiguration_put_UseArchive                  8 int
#comfunc global IFaxConfiguration_get_ArchiveLocation             9 var
#comfunc global IFaxConfiguration_put_ArchiveLocation             10 wstr
#comfunc global IFaxConfiguration_get_SizeQuotaWarning            11 var
#comfunc global IFaxConfiguration_put_SizeQuotaWarning            12 int
#comfunc global IFaxConfiguration_get_HighQuotaWaterMark          13 var
#comfunc global IFaxConfiguration_put_HighQuotaWaterMark          14 int
#comfunc global IFaxConfiguration_get_LowQuotaWaterMark           15 var
#comfunc global IFaxConfiguration_put_LowQuotaWaterMark           16 int
#comfunc global IFaxConfiguration_get_ArchiveAgeLimit             17 var
#comfunc global IFaxConfiguration_put_ArchiveAgeLimit             18 int
#comfunc global IFaxConfiguration_get_ArchiveSizeLow              19 var
#comfunc global IFaxConfiguration_get_ArchiveSizeHigh             20 var
#comfunc global IFaxConfiguration_get_OutgoingQueueBlocked        21 var
#comfunc global IFaxConfiguration_put_OutgoingQueueBlocked        22 int
#comfunc global IFaxConfiguration_get_OutgoingQueuePaused         23 var
#comfunc global IFaxConfiguration_put_OutgoingQueuePaused         24 int
#comfunc global IFaxConfiguration_get_AllowPersonalCoverPages     25 var
#comfunc global IFaxConfiguration_put_AllowPersonalCoverPages     26 int
#comfunc global IFaxConfiguration_get_UseDeviceTSID               27 var
#comfunc global IFaxConfiguration_put_UseDeviceTSID               28 int
#comfunc global IFaxConfiguration_get_Retries                     29 var
#comfunc global IFaxConfiguration_put_Retries                     30 int
#comfunc global IFaxConfiguration_get_RetryDelay                  31 var
#comfunc global IFaxConfiguration_put_RetryDelay                  32 int
#comfunc global IFaxConfiguration_get_DiscountRateStart           33 var
#comfunc global IFaxConfiguration_put_DiscountRateStart           34 double
#comfunc global IFaxConfiguration_get_DiscountRateEnd             35 var
#comfunc global IFaxConfiguration_put_DiscountRateEnd             36 double
#comfunc global IFaxConfiguration_get_OutgoingQueueAgeLimit       37 var
#comfunc global IFaxConfiguration_put_OutgoingQueueAgeLimit       38 int
#comfunc global IFaxConfiguration_get_Branding                    39 var
#comfunc global IFaxConfiguration_put_Branding                    40 int
#comfunc global IFaxConfiguration_get_IncomingQueueBlocked        41 var
#comfunc global IFaxConfiguration_put_IncomingQueueBlocked        42 int
#comfunc global IFaxConfiguration_get_AutoCreateAccountOnConnect  43 var
#comfunc global IFaxConfiguration_put_AutoCreateAccountOnConnect  44 int
#comfunc global IFaxConfiguration_get_IncomingFaxesArePublic      45 var
#comfunc global IFaxConfiguration_put_IncomingFaxesArePublic      46 int
#comfunc global IFaxConfiguration_Refresh                         47
#comfunc global IFaxConfiguration_Save                            48
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。