IVdsDisk3
COM公式ドキュメント
ディスクの位置パスを含む、ディスクのプロパティ情報を取得するためのメソッドを提供します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
ディスクのプロパティ情報を返します。このメソッドは、VDS_DISK_PROP 構造体ではなく VDS_DISK_PROP2 構造体を返す点を除き、IVdsDisk::GetProperties メソッドと同一です。
| pDiskProperties | VDS_DISK_PROP2* | out | 呼び出し元が割り当てて渡す VDS_DISK_PROP2 構造体のアドレスです。VDS は pwszDiskAddress、 pwszName、pwszFriendlyName、 pwszAdaptorName、pwszDevicePath、pwszLocationPath の各メンバー文字列にメモリを割り当てます。 呼び出し元は、 CoTaskMemFree 関数を使用してこれらの文字列を解放する必要があります。 |
戻り値
このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは、VDS 自体、または使用されている基盤の VDS プロバイダーから発生する可能性があります。戻り値としては次のものがあります。
| 戻り値/値 | 説明 |
|---|---|
| プロパティが正常に返されました。 | |
|
一部のプロパティは正常に取得されましたが、すべてを取得できたわけではありません。デバイスの取り外しなど、すべてのプロパティを取得できない理由は多数存在することに注意してください。 |
解説(Remarks)
pDiskProperties パラメーターで返される VDS_DISK_PROP2 構造体において、pwszDiskAddress メンバーは省略可能であり、値が存在しない場合は NULL になることがあります。このメソッドの呼び出し元は、このメンバーが NULL かどうかを確認する必要があります。
Hyper-V の場合、仮想コントローラーが位置パスを返さないため、pwszLocationPath メンバーは NULL になります。
ディスク上の空きエクステントを返し、指定された配置(アライメント)サイズに揃えます。
| ulAlign | DWORD | in | 配置サイズ(バイト単位)です。この値はディスクのセクターサイズの倍数でなければなりません。このパラメーターがゼロの場合、ボリュームの既定の配置値が使用されます。既定の配置は、ボリュームが配置されているディスクのサイズによって異なります。すべてのパーティションとボリュームは、次のレジストリキー配下の値を使用して配置されます。 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\vds\Alignment このレジストリキーが設定されていない場合、既定の配置は、ディスクが 4 GB 以上であれば 1 MB、4 GB 未満であれば 64 KB になります。 |
| ppFreeExtentArray | VDS_DISK_FREE_EXTENT** | out | 空きエクステントごとに 1 つずつ、VDS_DISK_FREE_EXTENT 構造体の配列を受け取る ポインター変数のアドレスです。 呼び出し元は、 CoTaskMemFree 関数を使用してこの配列を解放する必要があります。空きエクステントが存在しない場合、出力時にポインターは NULL に設定され、解放する必要はありません。 |
| plNumberOfFreeExtents | INT* | out | VDS_DISK_FREE_EXTENT 構造体の総数を受け取る変数へのポインターです。空きエクステントが存在しない場合、出力時にポインターは NULL に設定され、解放する必要はありません。 |
戻り値
このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは、VDS 自体、または使用されている基盤の VDS プロバイダーから発生する可能性があります。戻り値としては次のものがあります。
| 戻り値/値 | 説明 |
|---|---|
| 空きエクステント情報が正常に返されました。 | |
| ディスク上に空きエクステントがありません。 | |
|
ulAlign パラメーターで指定された配置値が、ディスクのセクターサイズの倍数ではありません。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IVdsDisk3 "{8F4B2F5D-EC15-4357-992F-473EF10975B9}" #usecom global IVdsDisk3 IID_IVdsDisk3 "{}" #comfunc global IVdsDisk3_GetProperties2 3 var #comfunc global IVdsDisk3_QueryFreeExtents 4 int,var,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IVdsDisk3 "{8F4B2F5D-EC15-4357-992F-473EF10975B9}" #usecom global IVdsDisk3 IID_IVdsDisk3 "{}" #comfunc global IVdsDisk3_GetProperties2 3 sptr #comfunc global IVdsDisk3_QueryFreeExtents 4 int,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。