Win32 API 日本語リファレンス
ホームGraphics.Imaging › IWICBitmapCodecProgressNotification

IWICBitmapCodecProgressNotification

COM
IID64c1024e-c3cf-4462-8078-88c2b11c46d9継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

エンコーダーおよびデコーダーの進捗通知に使用されるメソッドを公開します。

解説(Remarks)

このインターフェイスは、Windows が提供するコーデックではサポートされていません。

メソッド 1

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT RegisterProgressNotification(PFNProgressNotification pfnProgressNotification, void* pvData, DWORD dwProgressFlags)

進捗通知コールバック関数を登録します。

pfnProgressNotificationPFNProgressNotificationinoptionalアプリケーション定義の進捗通知コールバック関数への関数ポインター。コールバックのシグネチャについては ProgressNotificationCallback を参照してください。
pvDatavoid*inoptionalコールバックメソッド用のコンポーネントデータへのポインター。
dwProgressFlagsDWORDin進捗通知に使用する WICProgressOperation および WICProgressNotification フラグ。

戻り値

Type: HRESULT

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

解説(Remarks)

アプリケーションが登録できるコールバックは 1 つだけです。以降の登録呼び出しは、以前に登録されたコールバックを置き換えます。コールバックの登録を解除するには、NULL を渡すか、新しいコールバック関数を登録します。

進捗は 0.0 から 1.0 の間で増加する順序で報告されます。 dwProgressFlagsWICProgressNotificationBegin が含まれている場合、コールバックは進捗 0.0 で呼び出されることが保証されます。 dwProgressFlagsWICProgressNotificationEnd が含まれている場合、コールバックは進捗 1.0 で呼び出されることが保証されます。

WICProgressNotificationFrequent は、コールバックが呼び出される頻度を高めます。 操作に 30 秒以上かかることが予想される場合は、WICProgressNotificationFrequentdwProgressFlags に追加する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWICBitmapCodecProgressNotification "{64C1024E-C3CF-4462-8078-88C2B11C46D9}"
#usecom global IWICBitmapCodecProgressNotification IID_IWICBitmapCodecProgressNotification "{}"
#comfunc global IWICBitmapCodecProgressNotification_RegisterProgressNotification  3 sptr,sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。