Win32 API 日本語リファレンス
ホーム › Storage.VirtualDiskService › IVdsDisk

IVdsDisk

COM
📘 Microsoft Learn (日本語) · English
IID07e5c822-f00c-47a1-8fce-b244da56fd06継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ベーシックディスクおよびダイナミックディスクを照会および構成するためのメソッドを提供します。

メソッド 7

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

vtbl 3 HRESULT GetProperties(VDS_DISK_PROP* pDiskProperties)

ディスクのプロパティ情報を返します。

pDiskPropertiesVDS_DISK_PROP*out呼び出し元によって割り当てられ渡される VDS_DISK_PROP 構造体のアドレス。VDS は pwszDiskAddress、pwszName、pwszFriendlyName、pwszAdaptorName、pwszDevicePath の各メンバー文字列にメモリを割り当てます。呼び出し元は CoTaskMemFree 関数を使用してこれらの文字列を解放する必要があります。

戻り値

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

リターンコード/値 説明
S_OK
 プロパティが正常に返されました。
VDS_S_PROPERTIES_INCOMPLETE
0x00042715L
 一部のプロパティは正常に取得されましたが、すべてではありません。デバイスの取り外しなど、すべてのプロパティの取得に失敗する原因は数多く存在することに注意してください。
vtbl 4 HRESULT GetPack(IVdsPack** ppPack)

現在のディスクがメンバーとなっているディスクパックを返します。

ppPackIVdsPack**outVDS が戻り時に初期化する IVdsPack インターフェイスポインターのアドレス。呼び出し元は操作の完了時にインターフェイスを解放する必要があります。

戻り値

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

リターンコード/値 説明
S_OK
 ディスクパックアドレスへのポインターが正常に返されました。
VDS_E_DISK_NOT_INITIALIZED
0x80042417L
 未割り当てかつマスクされたディスクは、VDS によって管理されています。

解説(Remarks)

ディスクは 1 つのディスクパックのみのメンバーになることができます。

vtbl 5 HRESULT GetIdentificationData(VDS_LUN_INFORMATION* pLunInfo)

ディスクを一意に識別する情報を取得します。

pLunInfoVDS_LUN_INFORMATION*out呼び出し元によって割り当てられ渡される VDS_LUN_INFORMATION 構造体のアドレス。VDS は m_szVendorId、m_szProductId、m_szProductRevision、m_szSerialNumber の各メンバー文字列に加え、VDS_INTERCONNECT 構造体の配列の各要素における m_pbPort および m_pbAddress のメンバー文字列にメモリを割り当てます。呼び出し元は CoTaskMemFree 関数を使用してこれらの文字列を解放する必要があります。

戻り値

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

リターンコード 説明
S_OK
 識別データが正常に返されました。

解説(Remarks)

このメソッドは VDS によって実装されます。呼び出し元は、ハードウェアプロバイダーによって管理されるデバイスからのみ LUN 情報を抽出できます。

vtbl 6 HRESULT QueryExtents(VDS_DISK_EXTENT** ppExtentArray, INT* plNumberOfExtents)

ディスク上のすべてのエクステントの詳細を返します。

ppExtentArrayVDS_DISK_EXTENT**outVDS_DISK_EXTENT 構造体の配列を受け取るポインター変数。呼び出し元は CoTaskMemFree 関数を使用してこの配列を解放する必要があります。
plNumberOfExtentsINT*outエクステントの総数を表す LONG 型のアドレス。

戻り値

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

リターンコード/値 説明
S_OK
 エクステント情報が正常に返されました。
VDS_E_PACK_OFFLINE
0x80042444L
 ディスクが属するパックにアクセスできません。

解説(Remarks)

ボリュームの作成または拡張に使用できる空き領域の量を判別するには、このメソッドを使用します。また、エクステント情報を使用して、ディスクを占有しているボリュームの数を判別することもできます。有効なエクステントの種類は、unknown エクステント、free エクステント、data エクステント、OEM エクステント、ESP エクステント、MSR エクステント、LDM メタデータエクステント、および unusable エクステントです。data エクステントには、その上位にあるボリュームへのリンクが含まれます。

ディスクがダイナミックディスクである場合は、オンラインである必要があります。ベーシックディスクまたは raw ディスクである場合は、オンラインとオフラインのいずれでもかまいません。

vtbl 7 HRESULT ConvertStyle(VDS_PARTITION_STYLE NewStyle)

空のディスクのパーティションスタイルを、あるスタイルから別のスタイルへ変換します。

NewStyleVDS_PARTITION_STYLEinVDS_PARTITION_STYLE によって列挙されるパーティションスタイル。

戻り値

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

リターンコード/値 説明
S_OK
 変換が正常に完了しました。
VDS_E_INVALID_OPERATION
0x80042415L
 1394 または USB ディスク、および未割り当てディスクの場合と同様に、ディスクスタイルを変換できません。

解説(Remarks)

空のディスクには、ユーザーデータ、OEM パーティション、ESP パーティション、unknown パーティションが一切含まれません。空のディスク上で有効なのは、LDM メタデータパーティションと MSR パーティションのみです。

vtbl 8 HRESULT SetFlags(DWORD ulFlags)

ディスクオブジェクトのフラグを設定します。

ulFlagsDWORDin設定するフラグを指定する VDS_DISK_FLAG 列挙値のビットマスク。このメソッドで設定できるのは VDS_DF_READ_ONLY フラグのみです。その他のフラグはすべて VDS サービスによって設定または解除されます。

戻り値

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

リターンコード/値 説明
S_OK
 フラグが正常に設定されました。
VDS_E_DISK_NOT_INITIALIZED
0x80042417L
 初期化されていないディスクにはフラグを設定できません。
VDS_E_NOT_SUPPORTED
0x80042400L
 このメソッドはサポートされていません。ベーシックプロバイダーも現在のダイナミックプロバイダーも、このメソッドをサポートしていません。

解説(Remarks)

このメソッドは VDS によって実装されます。

vtbl 9 HRESULT ClearFlags(DWORD ulFlags)

ディスクオブジェクトのフラグを解除します。

ulFlagsDWORDin解除するフラグを指定する VDS_DISK_FLAG 列挙値のビットマスク。このメソッドで解除できるのは VDS_DF_READ_ONLY フラグのみです。その他のフラグはすべて VDS サービスによって設定または解除されます。

戻り値

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

リターンコード/値 説明
S_OK
 フラグが正常に解除されました。
VDS_E_NOT_SUPPORTED
0x80042400L
 このフラグはサポートされていません。ベーシックプロバイダーもダイナミックプロバイダーも、このフラグをサポートしていません。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsDisk "{07E5C822-F00C-47A1-8FCE-B244DA56FD06}"
#usecom global IVdsDisk IID_IVdsDisk "{}"
#comfunc global IVdsDisk_GetProperties          3 var
#comfunc global IVdsDisk_GetPack                4 sptr
#comfunc global IVdsDisk_GetIdentificationData  5 var
#comfunc global IVdsDisk_QueryExtents           6 var,var
#comfunc global IVdsDisk_ConvertStyle           7 int
#comfunc global IVdsDisk_SetFlags               8 int
#comfunc global IVdsDisk_ClearFlags             9 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。