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

IFaxIncomingArchive

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

公式ドキュメント

IFaxIncomingArchive インターフェースは、FAX クライアント アプリケーションが、FAX サービスによって正常に受信された着信 FAX メッセージのアーカイブにアクセスし、構成するために使用します。

メソッド 18

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

vtbl 7 HRESULT get_UseArchive(VARIANT_BOOL* pbUseArchive)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェースから IFaxConfiguration インターフェースを取得し、IFaxConfiguration::put_ArchiveLocation メソッドまたは IFaxConfiguration::get_ArchiveLocation メソッドを呼び出してください。
vtbl 10 HRESULT put_ArchiveFolder(LPWSTR bstrArchiveFolder)

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

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

解説(Remarks)

Note このプロパティは、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows ではサポートされていません。Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows でこのプロパティにアクセスするには、IFaxServer2 インターフェースから IFaxConfiguration インターフェースを取得し、IFaxConfiguration::put_ArchiveLocation メソッドまたは IFaxConfiguration::get_ArchiveLocation メソッドを呼び出してください。
vtbl 11 HRESULT get_SizeQuotaWarning(VARIANT_BOOL* pbSizeQuotaWarning)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、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)

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

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

解説(Remarks)

Note このプロパティは、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows ではサポートされていません。
アーカイブのサイズは 4 GB を超える場合があるため、アーカイブのサイズは 2 つの long 値で表されます。SizeLow はアーカイブ サイズの下位 32 ビット値、SizeHigh はアーカイブ サイズの上位 32 ビット値です。アーカイブのサイズは SizeLow + 4 GB * SizeHigh となります。

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

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

vtbl 20 HRESULT get_SizeHigh(INT* plSizeHigh)

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

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

解説(Remarks)

Note このプロパティは、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows ではサポートされていません。
アーカイブのサイズは 4 GB を超える場合があるため、アーカイブのサイズは 2 つの long 値で表されます。SizeLow はアーカイブ サイズの下位 32 ビット値、SizeHigh はアーカイブ サイズの上位 32 ビット値です。アーカイブのサイズは SizeLow + 4 GB * SizeHigh となります。

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

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

vtbl 21 HRESULT Refresh()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

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

戻り値

型: HRESULT

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

解説(Remarks)

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

GetMessages メソッドは、着信 FAX メッセージのアーカイブに対する新しい反復子 (アーカイブ カーソル) を返します。

lPrefetchSizeINTinプリフェッチ バッファーのサイズを示す long 値。この値は、反復子オブジェクトが内容を更新する必要があるときに FAX サーバーから取得する FAX メッセージの数を決定します。既定値は lDEFAULT_PREFETCH_SIZE です。
pFaxIncomingMessageIteratorIFaxIncomingMessageIterator**outFaxIncomingMessageIterator オブジェクト。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 24 HRESULT GetMessage(LPWSTR bstrMessageId, IFaxIncomingMessage** pFaxIncomingMessage)

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

bstrMessageIdLPWSTRin着信 FAX のアーカイブから取得する FAX のメッセージ ID を含む、null で終わる文字列を指定します。
pFaxIncomingMessageIFaxIncomingMessage**outFaxIncomingMessage オブジェクト。

戻り値

型: HRESULT

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxIncomingArchive "{76062CC7-F714-4FBD-AA06-ED6E4A4B70F3}"
#usecom global IFaxIncomingArchive IID_IFaxIncomingArchive "{}"
#comfunc global IFaxIncomingArchive_get_UseArchive          7 var
#comfunc global IFaxIncomingArchive_put_UseArchive          8 int
#comfunc global IFaxIncomingArchive_get_ArchiveFolder       9 var
#comfunc global IFaxIncomingArchive_put_ArchiveFolder       10 wstr
#comfunc global IFaxIncomingArchive_get_SizeQuotaWarning    11 var
#comfunc global IFaxIncomingArchive_put_SizeQuotaWarning    12 int
#comfunc global IFaxIncomingArchive_get_HighQuotaWaterMark  13 var
#comfunc global IFaxIncomingArchive_put_HighQuotaWaterMark  14 int
#comfunc global IFaxIncomingArchive_get_LowQuotaWaterMark   15 var
#comfunc global IFaxIncomingArchive_put_LowQuotaWaterMark   16 int
#comfunc global IFaxIncomingArchive_get_AgeLimit            17 var
#comfunc global IFaxIncomingArchive_put_AgeLimit            18 int
#comfunc global IFaxIncomingArchive_get_SizeLow             19 var
#comfunc global IFaxIncomingArchive_get_SizeHigh            20 var
#comfunc global IFaxIncomingArchive_Refresh                 21
#comfunc global IFaxIncomingArchive_Save                    22
#comfunc global IFaxIncomingArchive_GetMessages             23 int,sptr
#comfunc global IFaxIncomingArchive_GetMessage              24 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。