ホーム › Storage.VirtualDiskService › IVdsProviderPrivate

IVdsProviderPrivate

COM

📘 Microsoft Learn (日本語) · English

IID11f3cd41-b7e8-48ff-9472-9dff018aa292継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

VDS がプロバイダーオブジェクトに対してさまざまな操作を実行できるようにするためのメソッドを提供します。

メソッド 3

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

vtbl 3 HRESULT GetObject(GUID ObjectId, VDS_OBJECT_TYPE type, IUnknown** ppObjectUnk)

指定したオブジェクトを返します。

ObjectId	GUID	in	オブジェクトの GUID。
type	VDS_OBJECT_TYPE	in	VDS_OBJECT_TYPE によって列挙されるオブジェクトの種類。
ppObjectUnk	IUnknown**	out	オブジェクトの IUnknown ポインターのアドレス。ポインターが不要になったら、呼び出し元は IUnknown::Release メソッドを呼び出して解放する必要があります。

戻り値

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値を返すことができます。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダーから発生する可能性があります。返される可能性のある値には次のものがあります。

戻り値/値	説明
VDS_E_OBJECT_NOT_FOUND 0x80042405L	オブジェクトが見つかりませんでした。

解説(Remarks)

オブジェクトには、サブシステム、コントローラー、LUN、LUN プレックス、ドライブ、パック、ディスク、ボリューム、またはボリュームプレックスの各オブジェクトを指定できます。各オブジェクトは、物理デバイス(サブシステム、ドライブ、コントローラーなど)または仮想デバイス(LUN や LUN プレックスなど)を表します。ハードウェアプロバイダーは、物理デバイスまたは仮想デバイスごとに 1 つの COM オブジェクトを作成する必要があります。

vtbl 4 HRESULT OnLoad(LPWSTR pwszMachineName, IUnknown* pCallbackObject)

プロバイダーに対して自身を初期化するよう促し、プロバイダーが必要なインターフェイスを取得するために使用するコールバックオブジェクトを渡します。

pwszMachineName	LPWSTR	in	このパラメーターは予約されています。
pCallbackObject	IUnknown*	inoptional	コールバックオブジェクトへのポインター。

戻り値

戻り値/値	説明
S_OK	プロバイダーが初期化されました。
VDS_E_INITIALIZED_FAILED 0x80042401L	プロバイダーの初期化に失敗しました。

解説(Remarks)

VDS は、プロバイダーに対して CoCreateInstance メソッドを呼び出した直後に、このメソッドを呼び出します。

実装者はこのメソッドを実装する必要があります。IUnknown::QueryInterface メソッドを呼び出して IVdsAdviseSink インターフェイスを照会してください。

vtbl 5 HRESULT OnUnload(BOOL bForceUnload)

プロバイダーオブジェクトに対して自身を初期化解除するよう促します。

bForceUnload

BOOL

true の場合、VDS はプロバイダーを強制的にアンロードしようとします。false の場合、VDS はそのような試みを行いません。

戻り値

戻り値	説明
S_OK	プロバイダーがアンロードされました。
S_FALSE	プロバイダーは現時点でアンロードできません。VDS は後で再試行します。

解説(Remarks)

VDS は、プロバイダーオブジェクトへの参照を解放する直前にこのメソッドを呼び出します。参照カウントがゼロになると、プロバイダーはアンロードされます。OnLoad メソッドが失敗した場合、VDS は OnUnload を呼び出しません。

実装者への注意: OnUnload が呼び出されない場合でも、必要なクリーンアップをすべて実行する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsProviderPrivate "{11F3CD41-B7E8-48FF-9472-9DFF018AA292}"
#usecom global IVdsProviderPrivate IID_IVdsProviderPrivate "{}"
#comfunc global IVdsProviderPrivate_GetObject  3 int,int,sptr
#comfunc global IVdsProviderPrivate_OnLoad     4 wstr,sptr
#comfunc global IVdsProviderPrivate_OnUnload   5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。