ホーム › Storage.VirtualDiskService › IVdsDrive

IVdsDrive

COM

📘 Microsoft Learn (日本語) · English

IIDff24efa4-aade-4b6b-898b-eaa6a20887c7継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVdsDrive (vdshwprv.h) インターフェースは、ドライブに対するクエリ操作および構成操作を実行するためのメソッドを提供します。

メソッド 6

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

vtbl 3 HRESULT GetProperties(VDS_DRIVE_PROP* pDriveProp)

IVdsDrive::GetProperties (vdshwprv.h) メソッドは、ドライブオブジェクトのプロパティを返します。

pDriveProp

VDS_DRIVE_PROP*

out

呼び出し元が割り当てて渡す VDS_DRIVE_PROP 構造体のアドレスです。VDS は pwszFriendlyName および pwszIdentification メンバー文字列のメモリを割り当てます。呼び出し元は CoTaskMemFree 関数を使用してこれらの文字列を解放する必要があります。

戻り値

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

リターンコード/値	説明
VDS_S_PROPERTIES_INCOMPLETE 0x00042715L	一部のプロパティは正常に取得されましたが、すべてではありません。デバイスの取り外しなど、すべてのプロパティを取得できない理由は多数あることに注意してください。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	ドライブオブジェクトは存在しなくなりました。

vtbl 4 HRESULT GetSubSystem(IVdsSubSystem** ppSubSystem)

IVdsDrive::GetSubSystem (vdshwprv.h) メソッドは、ドライブが属するサブシステムを返します。

ppSubSystem

IVdsSubSystem**

out

IVdsSubSystem インターフェースポインターのアドレスです。呼び出し元はインターフェースを解放する必要があります。

戻り値

リターンコード/値	説明
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	ドライブオブジェクトは存在しなくなりました。

vtbl 5 HRESULT QueryExtents(VDS_DRIVE_EXTENT** ppExtentArray, INT* plNumberOfExtents)

VdsDrive::QueryExtents (vdshwprv.h) メソッドは、割り当て済みと未割り当ての両方を含む、ドライブ上のエクステントの配列を返します。

ppExtentArray	VDS_DRIVE_EXTENT**	out	呼び出し元が渡す VDS_DRIVE_EXTENT 構造体の配列へのポインターです。呼び出し元は CoTaskMemFree 関数を使用してこの配列を解放する必要があります。
plNumberOfExtents	INT*	out	VDS_DRIVE_EXTENT 構造体で返されるドライブエクステントの数へのポインターです。

戻り値

リターンコード/値	説明
S_OK	エクステント情報が正常に返されました。エクステントを持たないドライブの場合、配列は空になり、plNumberOfExtents の値は 0 に設定され、ppExtentArray の値は NULL に設定されます。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	ドライブオブジェクトは存在しなくなりました。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	ドライブは障害状態にあり、要求された操作を実行できません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_NOT_SUPPORTED 0x80042400L	サブシステムはこのメソッドをサポートしていません。

解説(Remarks)

1 台のドライブは任意の数の LUN にエクステントを提供でき、これらの LUN はネットワーク上の任意の数の異なるコンピューターに対してマスク解除できます。LUN プレックスのすべてのエクステントを確認するには、IVdsLunPlex::QueryExtents メソッドを使用してください。

各 VDS_DRIVE_EXTENT 構造体の LunId メンバーは、割り当てられた各エクステントが提供する先の LUN の GUID を指定します。したがって、このメソッドの結果を使用し、ppExtentArray で返される LunId 値の異なる個数を数えることで、ドライブが提供する先の LUN の数を判別できます。

vtbl 6 HRESULT SetFlags(DWORD ulFlags)

IVdsDrive::SetFlags (vdshwprv.h) メソッドは、ドライブオブジェクトのフラグを設定します。

ulFlags

DWORD

VDS_DRIVE_FLAG によって列挙されるフラグです。呼び出し元は VDS_DRF_HOTSPARE フラグを設定できます。

戻り値

リターンコード/値	説明
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	ドライブオブジェクトは存在しなくなりました。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	ドライブは障害状態にあり、要求された操作を実行できません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

vtbl 7 HRESULT ClearFlags(DWORD ulFlags)

IVdsDrive::ClearFlags (vdshwprv.h) メソッドは、ドライブオブジェクトのフラグをクリアします。

ulFlags

DWORD

VDS_DRIVE_FLAG によって列挙されるフラグです。呼び出し元は VDS_DRF_HOTSPARE フラグをクリアできます。

戻り値

リターンコード/値	説明
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	コントローラーオブジェクトは存在しなくなりました。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	ドライブは障害状態にあり、要求された操作を実行できません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

解説(Remarks)

ドライブフラグを設定するには IVdsDrive::SetFlags を使用し、現在設定されているフラグを取得するには IVdsDrive::GetProperties を使用してください。

vtbl 8 HRESULT SetStatus(VDS_DRIVE_STATUS status)

IVdsDrive::SetStatus (vdshwprv.h) メソッドは、ドライブのステータスを指定された値に設定します。

status

VDS_DRIVE_STATUS

VDS_DRIVE_STATUS によって列挙される値です。呼び出し元は、指定可能な列挙値のサブセットを渡すことができます。VDS_DRS_UNKNOWN を渡すと E_INVALIDARG が返されます。

戻り値

リターンコード/値	説明
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部でソフトウェアまたは通信の問題が発生したことを示します。キャッシュを復元するには、IVdsHwProvider::Reenumerate メソッドを実行し、続いて IVdsHwProvider::Refresh メソッドを実行してください。
VDS_E_OBJECT_DELETED 0x8004240BL	ドライブオブジェクトは存在しなくなりました。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	ドライブは障害状態にあり、要求された操作を実行できません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

解説(Remarks)

実装者は、ステータスを指定された状態にするために必要な操作を実行する責任があります。たとえば、呼び出し元がドライブのステータスとして VDS_DRS_OFFLINE を渡した場合、まずキャッシュをクリアする必要があるかもしれません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsDrive "{FF24EFA4-AADE-4B6B-898B-EAA6A20887C7}"
#usecom global IVdsDrive IID_IVdsDrive "{}"
#comfunc global IVdsDrive_GetProperties  3 var
#comfunc global IVdsDrive_GetSubSystem   4 sptr
#comfunc global IVdsDrive_QueryExtents   5 var,var
#comfunc global IVdsDrive_SetFlags       6 int
#comfunc global IVdsDrive_ClearFlags     7 int
#comfunc global IVdsDrive_SetStatus      8 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsDrive "{FF24EFA4-AADE-4B6B-898B-EAA6A20887C7}"
#usecom global IVdsDrive IID_IVdsDrive "{}"
#comfunc global IVdsDrive_GetProperties  3 sptr
#comfunc global IVdsDrive_GetSubSystem   4 sptr
#comfunc global IVdsDrive_QueryExtents   5 sptr,sptr
#comfunc global IVdsDrive_SetFlags       6 int
#comfunc global IVdsDrive_ClearFlags     7 int
#comfunc global IVdsDrive_SetStatus      8 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。