ホーム › System.ComponentServices › IServiceActivity

IServiceActivity

COM

📘 Microsoft Learn (日本語) · English

IID67532e0c-9e2f-4450-a354-035633944e17継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

CoCreateActivity によって作成されたアクティビティを通じて送信されるバッチ処理を呼び出すために使用します。

メソッド 4

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

vtbl 3 HRESULT SynchronousCall(IServiceCall* pIServiceCall)

ユーザー定義の処理を同期的に実行します。(IServiceActivity.SynchronousCall)

pIServiceCall

IServiceCall*

inoptional

バッチ処理を実装するために使用される IServiceCall インターフェイスへのポインター。

戻り値

このメソッドは常に、IServiceCall インターフェイスの OnCall メソッドが返す HRESULT 値を返します。

解説(Remarks)

このメソッドを介して実行されるバッチ処理は、CoCreateActivity の呼び出しによって作成されたアクティビティのコンテキストおよびスレッドアパートメント内で実行されます。

vtbl 4 HRESULT AsynchronousCall(IServiceCall* pIServiceCall)

ユーザー定義の処理を非同期的に実行します。(IServiceActivity.AsynchronousCall)

pIServiceCall

IServiceCall*

inoptional

バッチ処理を実装するために使用される IServiceCall インターフェイスへのポインター。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_FAIL のほか、次の値を返すことがあります。

戻り値	説明
S_OK	バッチ処理が非同期的に実行されるものとしてアクティビティに受理されました。この戻り値は、バッチ処理が正常に完了したことを必ずしも意味しません。
CO_E_ASYNC_WORK_REJECTED	バッチ処理をアクティビティの非同期処理キューに追加できません。

解説(Remarks)

このメソッドによって実行されるバッチ処理は、CoCreateActivity の呼び出しによって作成されたアクティビティのコンテキストおよびスレッドアパートメント内で実行されます。

vtbl 5 HRESULT BindToCurrentThread()

ユーザー定義のバッチ処理を現在のスレッドにバインドします。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_FAIL、S_OK を返すことがあります。

解説(Remarks)

このメソッドは、AsynchronousCall メソッドまたは SynchronousCall メソッドを介して送信されたバッチ処理を、現在のシングルスレッドアパートメント (STA) にバインドします。現在のスレッドがマルチスレッドアパートメント (MTA) で実行されている場合、このメソッドは効果がありません。現在のスレッドモデルは、CoCreateActivity の呼び出し時に pIUnknown パラメーターを介して渡された CServiceConfig オブジェクトの IServiceThreadPoolConfig インターフェイスの構成によって決定されます。

このメソッドを呼び出すことは、CoCreateActivity に pIUnknown パラメーターを介して渡された CServiceConfig オブジェクトに対して CSC_BindToPoolThread を指定して IServiceThreadPoolConfig::SetBindingInfo を呼び出すことと同等です。ただし、CoCreateActivity によってアクティビティが作成された後は、スレッドバインドを変更するために IServiceThreadPoolConfig::SetBindingInfo を呼び出すことはできなくなります。アクティビティの作成後にスレッドバインドを変更するには、IServiceActivity の BindToCurrentThread メソッドまたは UnbindFromThread メソッドを呼び出す必要があります。

vtbl 6 HRESULT UnbindFromThread()

ユーザー定義のバッチ処理を、それが実行されているスレッドからバインド解除します。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_FAIL、S_OK を返すことがあります。

解説(Remarks)

このメソッドは、AsynchronousCall メソッドまたは SynchronousCall メソッドを介して送信されたバッチ処理を、それが実行されているスレッドからバインド解除します。バッチ処理が事前にスレッドにバインドされていなかった場合、このメソッドは効果がありません。

このメソッドを呼び出すことは、CoCreateActivity に pIUnknown パラメーターを介して渡された CServiceConfig オブジェクトに対して CSC_NoBinding を指定して IServiceThreadPoolConfig::SetBindingInfo を呼び出すことと同等です。ただし、CoCreateActivity によってアクティビティが作成された後は、スレッドバインドを変更するために IServiceThreadPoolConfig::SetBindingInfo を呼び出すことはできなくなります。アクティビティの作成後にスレッドバインドを変更するには、IServiceActivity の BindToCurrentThread メソッドまたは UnbindFromThread メソッドを呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IServiceActivity "{67532E0C-9E2F-4450-A354-035633944E17}"
#usecom global IServiceActivity IID_IServiceActivity "{}"
#comfunc global IServiceActivity_SynchronousCall      3 sptr
#comfunc global IServiceActivity_AsynchronousCall     4 sptr
#comfunc global IServiceActivity_BindToCurrentThread  5
#comfunc global IServiceActivity_UnbindFromThread     6
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。