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

IFaxAccountOutgoingArchive

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

公式ドキュメント

FAX クライアント アプリケーションが、指定した FAX アカウントの送信済み FAX メッセージのアーカイブにアクセスするために使用します。このインターフェイスは、メッセージの取得やアーカイブのサイズの取得に使用します。

メソッド 5

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

vtbl 7 HRESULT get_SizeLow(INT* plSizeLow)

特定の FAX アカウントの送信 FAX メッセージ アーカイブのサイズ (バイト単位) の下位 32 ビット値を指定します。

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

解説(Remarks)

アーカイブのサイズは 4 GB を超える場合があるため、サイズは 64 ビット整数として扱われ、その値は 2 つの 32 ビット整数値として返されます。SizeLow はアーカイブ サイズの下位 32 ビット値を返します。SizeHigh はアーカイブ サイズの上位 32 ビット値を返します。アーカイブ サイズの 64 ビット値は次のように計算できます: Size64 = (SizeHigh << 32) + SizeLow。

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

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

vtbl 8 HRESULT get_SizeHigh(INT* plSizeHigh)

特定の FAX アカウントの送信 FAX メッセージ アーカイブのサイズ (バイト単位) の上位 32 ビット値を指定します。

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

解説(Remarks)

アーカイブのサイズは 4 GB を超える場合があるため、サイズは 64 ビット整数として扱われ、その値は 2 つの 32 ビット整数値として返されます。SizeLow はアーカイブ サイズの下位 32 ビット値を返します。SizeHigh はアーカイブ サイズの上位 32 ビット値を返します。アーカイブ サイズの 64 ビット値は次のように計算できます: Size64 = (SizeHigh << 32) + SizeLow。

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

このプロパティは読み取り専用です。

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

vtbl 9 HRESULT Refresh()

特定の FAX アカウントの FaxAccountOutgoingArchive オブジェクトの情報を、FAX サーバーから最新の状態に更新します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 10 HRESULT GetMessages(INT lPrefetchSize, IFaxOutgoingMessageIterator** pFaxOutgoingMessageIterator)

特定の FAX アカウントの送信 FAX メッセージ アーカイブに対する新しい反復子 (アーカイブ カーソル) を返します。

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

戻り値

型: HRESULT

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

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

FAX メッセージ ID を使用して、特定の FAX アカウントの送信 FAX アーカイブから FAX メッセージを返します。

bstrMessageIdLPWSTRin送信 FAX のアーカイブから取得する FAX のメッセージ ID を格納した、null で終わる文字列を指定します。
pFaxOutgoingMessageIFaxOutgoingMessage**outIFaxOutgoingMessage オブジェクトです。

戻り値

型: 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_IFaxAccountOutgoingArchive "{5463076D-EC14-491F-926E-B3CEDA5E5662}"
#usecom global IFaxAccountOutgoingArchive IID_IFaxAccountOutgoingArchive "{851E7AF5-433A-4739-A2DF-AD245C2CB98E}"
#comfunc global IFaxAccountOutgoingArchive_get_SizeLow   7 var
#comfunc global IFaxAccountOutgoingArchive_get_SizeHigh  8 var
#comfunc global IFaxAccountOutgoingArchive_Refresh       9
#comfunc global IFaxAccountOutgoingArchive_GetMessages   10 int,sptr
#comfunc global IFaxAccountOutgoingArchive_GetMessage    11 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。