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

IFaxOutgoingArchive

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

公式ドキュメント

IFaxOutgoingArchive インターフェイスは、FAX サービスが送信に成功した送信 FAX メッセージのアーカイブに、FAX クライアント アプリケーションがアクセスして構成するために使用する構成オブジェクトを表します。

解説(Remarks)

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

メソッド 18

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

vtbl 7 HRESULT get_UseArchive(VARIANT_BOOL* pbUseArchive)

IFaxOutgoingArchive::get_UseArchive プロパティは、FAX サービスが送信 FAX メッセージをアーカイブするかどうかを示すブール値です。(Get)

pbUseArchiveVARIANT_BOOL*out送信アーカイブ機能が有効かを受け取るVARIANT_BOOLポインタ。VARIANT_TRUEで有効。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_UseArchive メソッドまたは IFaxConfiguration::get_UseArchive メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 8 HRESULT put_UseArchive(VARIANT_BOOL bUseArchive)

IFaxOutgoingArchive::get_UseArchive プロパティは、FAX サービスが送信 FAX メッセージをアーカイブするかどうかを示すブール値です。(Put)

bUseArchiveVARIANT_BOOLin送信アーカイブ機能の有効/無効を設定するVARIANT_BOOL。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_UseArchive メソッドまたは IFaxConfiguration::get_UseArchive メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 9 HRESULT get_ArchiveFolder(LPWSTR* pbstrArchiveFolder)

IFaxOutgoingArchive::get_ArchiveFolder プロパティは、アーカイブされた送信 FAX を格納する FAX サーバー上のフォルダーの場所を指定する、null 終端文字列です。(Get)

pbstrArchiveFolderLPWSTR*out送信ファクスを保存するアーカイブフォルダのパスを受け取るBSTR文字列ポインタ。呼出側で解放する。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_ArchiveLocation メソッドまたは IFaxConfiguration::get_ArchiveLocation メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 10 HRESULT put_ArchiveFolder(LPWSTR bstrArchiveFolder)

IFaxOutgoingArchive::get_ArchiveFolder プロパティは、アーカイブされた送信 FAX を格納する FAX サーバー上のフォルダーの場所を指定する、null 終端文字列です。(Put)

bstrArchiveFolderLPWSTRin送信ファクスを保存するアーカイブフォルダのパスを設定するBSTR文字列。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_ArchiveLocation メソッドまたは IFaxConfiguration::get_ArchiveLocation メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 11 HRESULT get_SizeQuotaWarning(VARIANT_BOOL* pbSizeQuotaWarning)

IFaxOutgoingArchive::get_SizeQuotaWarning プロパティは、送信アーカイブのサイズが IFaxOutgoingArchive::get_HighQuotaWaterMark プロパティで定義された上限を超えたときに、FAX サービスがイベント ログに警告を出力するかどうかを示すブール値です。(Get)

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_SizeQuotaWarning メソッドまたは IFaxConfiguration::get_SizeQuotaWarning メソッドを呼び出してください。
このプロパティが TRUE の場合、アーカイブ内の FAX メッセージ数が上限を超えたときに FAX サービスは警告を出力します。このプロパティが FALSE の場合、FAX サービスは警告を出力しません。

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

vtbl 12 HRESULT put_SizeQuotaWarning(VARIANT_BOOL bSizeQuotaWarning)

IFaxOutgoingArchive::get_SizeQuotaWarning プロパティは、送信アーカイブのサイズが IFaxOutgoingArchive::get_HighQuotaWaterMark プロパティで定義された上限を超えたときに、FAX サービスがイベント ログに警告を出力するかどうかを示すブール値です。(Put)

bSizeQuotaWarningVARIANT_BOOLinアーカイブサイズ超過時の警告の有効/無効を設定するVARIANT_BOOL。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_SizeQuotaWarning メソッドまたは IFaxConfiguration::get_SizeQuotaWarning メソッドを呼び出してください。
このプロパティが TRUE の場合、アーカイブ内の FAX メッセージ数が上限を超えたときに FAX サービスは警告を出力します。このプロパティが FALSE の場合、FAX サービスは警告を出力しません。

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

vtbl 13 HRESULT get_HighQuotaWaterMark(INT* plHighQuotaWaterMark)

IFaxOutgoingArchive::get_HighQuotaWaterMark プロパティは、受信 FAX メッセージのアーカイブ サイズの上限しきい値をメガバイト単位で指定する値です。(Get)

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_HighQuotaWaterMark メソッドまたは IFaxConfiguration::get_HighQuotaWaterMark メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 14 HRESULT put_HighQuotaWaterMark(INT lHighQuotaWaterMark)

IFaxOutgoingArchive::get_HighQuotaWaterMark プロパティは、受信 FAX メッセージのアーカイブ サイズの上限しきい値をメガバイト単位で指定する値です。(Put)

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_HighQuotaWaterMark メソッドまたは IFaxConfiguration::get_HighQuotaWaterMark メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 15 HRESULT get_LowQuotaWaterMark(INT* plLowQuotaWaterMark)

IFaxOutgoingArchive::get_LowQuotaWaterMark プロパティは、送信 FAX メッセージのアーカイブの下限しきい値をメガバイト単位で指定する値です。(Get)

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_LowQuotaWaterMark メソッドまたは IFaxConfiguration::get_LowQuotaWaterMark メソッドを呼び出してください。
このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 16 HRESULT put_LowQuotaWaterMark(INT lLowQuotaWaterMark)

IFaxOutgoingArchive::get_LowQuotaWaterMark プロパティは、送信 FAX メッセージのアーカイブの下限しきい値をメガバイト単位で指定する値です。(Put)

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_LowQuotaWaterMark メソッドまたは IFaxConfiguration::get_LowQuotaWaterMark メソッドを呼び出してください。
このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 17 HRESULT get_AgeLimit(INT* plAgeLimit)

IFaxOutgoingArchive::get_AgeLimit プロパティは、FAX サービスが送信 FAX のアーカイブ内に FAX メッセージを保持する日数を示す値です。(Get)

plAgeLimitINT*outアーカイブ保持期間の上限日数を受け取るINTポインタ。0は無制限を意味する。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_ArchiveAgeLimit メソッドまたは IFaxConfiguration::get_ArchiveAgeLimit メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 18 HRESULT put_AgeLimit(INT lAgeLimit)

IFaxOutgoingArchive::get_AgeLimit プロパティは、FAX サービスが送信 FAX のアーカイブ内に FAX メッセージを保持する日数を示す値です。(Put)

lAgeLimitINTinアーカイブ保持期間の上限日数を設定するINT。0は無制限を意味する。

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::put_ArchiveAgeLimit メソッドまたは IFaxConfiguration::get_ArchiveAgeLimit メソッドを呼び出してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 19 HRESULT get_SizeLow(INT* plSizeLow)

IFaxOutgoingArchive::get_SizeLow プロパティは、送信 FAX メッセージのアーカイブのサイズ (バイト単位) の下位 32 ビット値を指定する値です。

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::get_ArchiveSizeLow メソッドを呼び出してください。
アーカイブのサイズは 4 ギガバイト (GB) を超える可能性があるため、アーカイブ サイズは 2 つの long 値で表されます。SizeLow はアーカイブ サイズの下位 32 ビット値であり、SizeHigh はアーカイブ サイズの上位 32 ビット値です。アーカイブのサイズは SizeLow + 4 GB * SizeHigh となります。SizeLow プロパティと SizeHigh プロパティの両方が 0xffffffff の値を持つ場合、それらは無効なアーカイブ サイズを表すため、両方のプロパティ値を無視してください。

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

vtbl 20 HRESULT get_SizeHigh(INT* plSizeHigh)

IFaxOutgoingArchive::get_SizeHigh プロパティは、送信 FAX メッセージのアーカイブのサイズ (バイト単位) の上位 32 ビット値を指定する値です。

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

解説(Remarks)

メモ このプロパティは、Windows Vista、Windows Server 2008 以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008 以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェイスから IFaxConfiguration インターフェイスを取得し、IFaxConfiguration::get_ArchiveSizeHigh メソッドを呼び出してください。
アーカイブのサイズは 4 ギガバイト (GB) を超える可能性があるため、アーカイブ サイズは 2 つの long 値で表されます。SizeLow はアーカイブ サイズの下位 32 ビット値であり、SizeHigh はアーカイブ サイズの上位 32 ビット値です。アーカイブのサイズは SizeLow + 4 GB * SizeHigh となります。SizeLow プロパティと SizeHigh プロパティの両方が 0xffffffff の値を持つ場合、それらは無効なアーカイブ サイズを表すため、両方のプロパティ値を無視してください。

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

vtbl 21 HRESULT Refresh()

IFaxOutgoingArchive::Refresh メソッドは、FaxOutgoingArchive オブジェクトの情報を FAX サーバーから最新の状態に更新します。

戻り値

型: HRESULT

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

解説(Remarks)

メモ Windows Vista、Windows Server 2008 以降のバージョンの Windows では、このメソッドはサポートされておらず、エラーを返します。
このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 22 HRESULT Save()

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

戻り値

型: HRESULT

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

解説(Remarks)

メモ Windows Vista、Windows Server 2008 以降のバージョンの Windows では、このメソッドはサポートされておらず、エラーを返します。
このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 23 HRESULT GetMessages(INT lPrefetchSize, IFaxOutgoingMessageIterator** pFaxOutgoingMessageIterator)

IFaxOutgoingArchive::GetMessages メソッドは、送信 FAX メッセージのアーカイブに対する新しい反復子 (アーカイブ カーソル) を返します。詳細については、IFaxOutgoingMessageIterator を参照してください。

lPrefetchSizeINTinプリフェッチ バッファーのサイズを指定する long 値です。この値は、反復子オブジェクトが内容を更新する必要があるときに FAX サーバーから取得する FAX メッセージの数を決定します。既定値は lDEFAULT_PREFETCH_SIZE です。
pFaxOutgoingMessageIteratorIFaxOutgoingMessageIterator**outIFaxOutgoingMessageIterator インターフェイスを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farQUERY_OUT_ARCHIVE アクセス権を持っている必要があります。farSUBMIT_LOW アクセス権では、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farQUERY_OUT_ARCHIVE アクセス権では、サーバー上のすべての FAX に対してこのメソッドを使用できます。

vtbl 24 HRESULT GetMessage(LPWSTR bstrMessageId, IFaxOutgoingMessage** pFaxOutgoingMessage)

IFaxOutgoingArchive::GetMessage メソッドは、FAX メッセージ ID を使用して、送信 FAX のアーカイブから FAX メッセージを返します。

bstrMessageIdLPWSTRin送信 FAX のアーカイブから取得する FAX のメッセージ ID を格納した、null 終端文字列を指定します。
pFaxOutgoingMessageIFaxOutgoingMessage**outIFaxOutgoingMessage インターフェイスを受け取るポインターのアドレスです。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farQUERY_OUT_ARCHIVE アクセス権を持っている必要があります。farSUBMIT_LOW アクセス権では、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farQUERY_OUT_ARCHIVE アクセス権では、サーバー上のすべての 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_IFaxOutgoingArchive "{C9C28F40-8D80-4E53-810F-9A79919B49FD}"
#usecom global IFaxOutgoingArchive IID_IFaxOutgoingArchive "{}"
#comfunc global IFaxOutgoingArchive_get_UseArchive          7 var
#comfunc global IFaxOutgoingArchive_put_UseArchive          8 int
#comfunc global IFaxOutgoingArchive_get_ArchiveFolder       9 var
#comfunc global IFaxOutgoingArchive_put_ArchiveFolder       10 wstr
#comfunc global IFaxOutgoingArchive_get_SizeQuotaWarning    11 var
#comfunc global IFaxOutgoingArchive_put_SizeQuotaWarning    12 int
#comfunc global IFaxOutgoingArchive_get_HighQuotaWaterMark  13 var
#comfunc global IFaxOutgoingArchive_put_HighQuotaWaterMark  14 int
#comfunc global IFaxOutgoingArchive_get_LowQuotaWaterMark   15 var
#comfunc global IFaxOutgoingArchive_put_LowQuotaWaterMark   16 int
#comfunc global IFaxOutgoingArchive_get_AgeLimit            17 var
#comfunc global IFaxOutgoingArchive_put_AgeLimit            18 int
#comfunc global IFaxOutgoingArchive_get_SizeLow             19 var
#comfunc global IFaxOutgoingArchive_get_SizeHigh            20 var
#comfunc global IFaxOutgoingArchive_Refresh                 21
#comfunc global IFaxOutgoingArchive_Save                    22
#comfunc global IFaxOutgoingArchive_GetMessages             23 int,sptr
#comfunc global IFaxOutgoingArchive_GetMessage              24 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。