ホーム › Storage.VirtualDiskService › IVdsServiceUninstallDisk

IVdsServiceUninstallDisk

COM

📘 Microsoft Learn (日本語) · English

IIDb6b22da8-f903-4be7-b492-c09d875ac9da継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ベーシックディスクおよびダイナミックディスクをアンインストールするためのメソッドを提供します。

メソッド 2

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

vtbl 3 HRESULT GetDiskIdFromLunInfo(VDS_LUN_INFORMATION* pLunInfo, GUID* pDiskId)

指定した LUN に対応するディスクの VDS オブジェクト ID を取得します。

pLunInfo	VDS_LUN_INFORMATION*	in	VDS ハードウェアプロバイダーによって初期化された VDS_LUN_INFORMATION 構造体のアドレス。
pDiskId	GUID*	out	呼び出し元が渡す VDS オブジェクト ID 変数のアドレス。この変数は、LUN に対応するディスクの GUID を受け取ります。

戻り値

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

リターンコード/値	説明
S_OK	ディスクの GUID が正常に返されました。
VDS_E_NO_DISK_PATHNAME 0x8004270FL	ディスクのパスを取得できませんでした。ディスクに対する一部の操作が失敗する可能性があります。
VDS_E_OBJECT_NOT_FOUND 0x80042405L	ディスクが見つかりませんでした。

解説(Remarks)

このメソッドは VDS が実装します。このメソッドは、別のコンピューター上の VDS ハードウェアプロバイダーを介して LUN にアクセスするディスクをアンインストールする必要がある VDS アプリケーションから呼び出されます。このメソッドを使用すると、VDS ハードウェアプロバイダーにアクセスできず、そのためディスクから LUN への暗黙的なリンクを作成できないコンピューター上でも、アプリケーションがディスクをアンインストールできるようになります。

vtbl 4 HRESULT UninstallDisks(GUID* pDiskIdArray, DWORD ulCount, BOOLEAN bForce, BYTE* pbReboot, HRESULT* pResults)

一連のディスクをアンインストールします。

pDiskIdArray	GUID*	in	アンインストールする各ディスクにつき 1 つずつ、VDS オブジェクト ID の配列を格納するバッファーのアドレス。配列内の各 ID は一意である必要があります。
ulCount	DWORD	in	pDiskIdArray パラメーターが指すバッファー内の VDS オブジェクト ID の数。
bForce	BOOLEAN	in	TRUE の場合、ボリュームをロックまたはマウント解除できない場合でも、VDS はディスクをアンインストールします。
pbReboot	BYTE*	out	アンインストール処理を完了するためにユーザーがコンピューターを再起動する必要がある場合に TRUE を受け取る BOOLEAN 変数のアドレス。
pResults	HRESULT*	out	呼び出し元が割り当てた HRESULT 値の配列のアドレス。配列内の要素数は pDiskIdArray パラメーターが指します。この配列の最初の要素は pDiskIdArray の最初の要素に対応し、以降も同様です。いずれかのディスクが正しく初期化されなかった場合、その失敗に対応する具体的なエラーコードが、この配列の対応する要素に返されます。

戻り値

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

リターンコード/値	説明
S_OK 0	ディスクが正常にアンインストールされました。
S_FALSE 1	このメソッドは、1 つ以上のディスクについて警告またはエラーコードを返しました。
VDS_S_UNABLE_TO_GET_GPT_ATTRIBUTES 0x0004245BL	ディスクは正常にアンインストールされましたが、1 つ以上のディスクについて GUID パーティションテーブル (GPT) 属性を取得できませんでした。
VDS_E_INTERNAL_ERROR 0x80042448L	VDS で内部エラーが発生しました。詳細についてはイベントログを確認してください。
VDS_E_MISSING_DISK 0x80042454L	1 つ以上のディスクが見つかりませんでした。
VDS_E_NO_DISK_PATHNAME 0x8004270FL	1 つ以上のディスクについてパスを取得できませんでした。
VDS_E_NO_VOLUME_PATHNAME 0x80042711L	1 つ以上のボリュームについてパスを取得できませんでした。
VDS_E_OBJECT_DELETED 0x8004240BL	指定された VDS オブジェクト ID の 1 つ以上が、既に存在しないディスクに対応しています。
VDS_E_OBJECT_NOT_FOUND 0x80042405L	指定された VDS オブジェクト ID の 1 つ以上が、存在しないディスクに対応しています。
VDS_E_PROVIDER_CACHE_OUTOFSYNC 0x80042712L	プロバイダーのキャッシュがドライバーのキャッシュと同期していません。

解説(Remarks)

このメソッドは VDS が実装します。

このメソッドは同期的であり、まず指定したディスク上のボリュームをアンインストールし、その後ディスクをアンインストールします。ディスクがアンインストールされると、対応する LUN をマスク (非表示) または削除できるようになります。

このメソッドは、ディスク上のボリュームに割り当てられていたドライブ文字をクリーンアップします。さらに、マウント解除ハンドルが閉じられた後、実際にディスクが取り外される前にボリュームが再マウントされるのを防ぐため、ボリュームをオフラインに設定します。

複数のディスクにまたがるダイナミックボリュームを削除する場合は、デバイスマネージャーの機能を使用する代わりに、必ずこのメソッドを呼び出す必要があります。

UninstallDisks メソッドがサポートされていない Windows Server 2003 リリースでディスクをアンインストールする方法については、IVdsLun::SetMask メソッドの「解説」セクションを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsServiceUninstallDisk "{B6B22DA8-F903-4BE7-B492-C09D875AC9DA}"
#usecom global IVdsServiceUninstallDisk IID_IVdsServiceUninstallDisk "{}"
#comfunc global IVdsServiceUninstallDisk_GetDiskIdFromLunInfo  3 var,var
#comfunc global IVdsServiceUninstallDisk_UninstallDisks        4 var,int,int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IVdsServiceUninstallDisk "{B6B22DA8-F903-4BE7-B492-C09D875AC9DA}"
#usecom global IVdsServiceUninstallDisk IID_IVdsServiceUninstallDisk "{}"
#comfunc global IVdsServiceUninstallDisk_GetDiskIdFromLunInfo  3 sptr,sptr
#comfunc global IVdsServiceUninstallDisk_UninstallDisks        4 sptr,int,int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。