ホーム › Storage.VirtualDiskService › IVdsVolumeMF3

IVdsVolumeMF3

COM

📘 Microsoft Learn (日本語) · English

IID6788faf9-214e-4b85-ba59-266953616e09継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ボリュームオブジェクトに対して追加のファイルシステム管理操作を実行するためのメソッドを提供します。(IVdsVolumeMF3)

メソッド 3

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

vtbl 3 HRESULT QueryVolumeGuidPathnames(LPWSTR** pwszPathArray, DWORD* pulNumberOfPaths)

現在のボリュームに対するボリューム GUID パスの一覧を返します。

pwszPathArray	LPWSTR**	out	CoTaskMemFree
pulNumberOfPaths	DWORD*	out	pwszPathArray パラメーターが指すバッファーに返されるボリューム GUID パスの数を受け取る変数へのポインター。

戻り値

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

リターンコード/値	説明
S_OK	メソッドは正常に完了しました。
VDS_E_INTERNAL_ERROR 0x80042448L	内部エラーが発生しました。詳細についてはイベントログを確認してください。

解説(Remarks)

ボリューム GUID パスは "\?\Volume{GUID}" という形式の文字列で、GUID はボリュームを識別する GUID です。

vtbl 4 HRESULT FormatEx2(LPWSTR pwszFileSystemTypeName, WORD usFileSystemRevision, DWORD ulDesiredUnitAllocationSize, LPWSTR pwszLabel, DWORD Options, IVdsAsync** ppAsync)

パーティション上のファイルシステムボリュームをフォーマットします。このメソッドは、フォーマットオプションを Options パラメーターで指定する点を除いて、IVdsVolumeMF2::FormatEx メソッドと同一です。

pwszFileSystemTypeName	LPWSTR	in	ボリュームをフォーマットするために使用するファイルシステムの名前を含む null 終端の Unicode 文字列。このパラメーターには NULL または Windows のファイルシステム名を指定できます。サポートされるファイルシステムは次のとおりです: "NTFS"、"FAT"、"FAT32"、"UDF"、"EXFAT"。このパラメーターが NULL の場合、既定のファイルシステムが使用されます。詳細については、VDS_FILE_SYSTEM_FORMAT_SUPPORT_FLAG を参照してください。
usFileSystemRevision	WORD	in	ファイルシステムのリビジョン(存在する場合)。このメンバーは 16 ビットの 2 進化 10 進数で表され、2 桁目と 3 桁目の間に小数点があるものとみなされます。たとえば、0x0250 という値はリビジョン 2.50 を示します。
ulDesiredUnitAllocationSize	DWORD	in	ファイルシステムのアロケーションユニットのサイズ(バイト単位)。値は 2 のべき乗である必要があります。値が 0 の場合、ファイルシステムの種類によって決まる既定のアロケーションユニットが使用されます。アロケーションユニットの範囲はファイルシステムに依存します。
pwszLabel	LPWSTR	in	新しいファイルシステムに割り当てる null 終端の Unicode 文字列。ラベルの最大サイズはファイルシステムに依存します。
Options	DWORD	in	フォーマットオプションを指定する VDS_FORMAT_OPTION_FLAGS 列挙値のビットマスク。
ppAsync	IVdsAsync**	out	正常に完了すると、この操作を監視および制御するための IVdsAsync インターフェイスを受け取る IVdsAsync インターフェイスへのポインター。呼び出し元は、受け取ったインターフェイスの使用が終わったら解放する必要があります。

戻り値

リターンコード/値	説明
S_OK 0x00000000L	ファイルシステムは正常にフォーマットされました。
VDS_E_OPERATION_DENIED 0x8004240AL	呼び出し元がシステム、ブート、クラッシュダンプ、休止状態、またはページファイルのボリュームをフォーマットしようとした場合、この操作は拒否されます。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	ボリュームが失敗しました。
VDS_E_PACK_OFFLINE 0x80042444L	ボリュームを含むパックにアクセスできません。オフラインのパックに含まれるすべてのボリュームにはアクセスできません。
VDS_E_FS_NOT_DETERMINED 0x80042593L	既定のファイルシステムを特定できませんでした。

さらに、IVdsAsync インターフェイスは次の関連する警告およびエラーコードを返すことがあります。

リターンコード/値	説明
VDS_E_INCOMPATIBLE_FILE_SYSTEM 0x80042425L	ファイルシステムに互換性がありません。
VDS_E_INCOMPATIBLE_MEDIA 0x80042426L	メディアに互換性がありません。
VDS_E_ACCESS_DENIED 0x80042427L	アクセスが拒否されました。
VDS_E_MEDIA_WRITE_PROTECTED 0x80042428L	メディアは書き込み保護されています。
VDS_E_BAD_LABEL 0x80042429L	ラベルが無効です。
VDS_E_CANT_QUICK_FORMAT 0x8004242AL	ボリュームをクイックフォーマットできません。
VDS_E_IO_ERROR 0x8004242BL	フォーマット中に I/O エラーが発生しました。
VDS_E_VOLUME_TOO_SMALL 0x8004242CL	ボリュームサイズが小さすぎるためフォーマットできません。
VDS_E_VOLUME_TOO_BIG 0x8004242DL	ボリュームサイズが大きすぎるためフォーマットできません。
VDS_E_CLUSTER_SIZE_TOO_SMALL 0x8004242EL	クラスターサイズが小さすぎるためフォーマットできません。
VDS_E_CLUSTER_SIZE_TOO_BIG 0x8004242FL	クラスターサイズが大きすぎるためフォーマットできません。
VDS_E_CLUSTER_COUNT_BEYOND_32BITS 0x80042430L	クラスター数が多すぎて 32 ビット整数で表現できません。
VDS_S_VOLUME_COMPRESS_FAILED 0x00042443L	ファイルシステムはフォーマットされましたが、圧縮されていません。
VDS_E_CANT_INVALIDATE_FVE 0x80042592L	ボリュームの BitLocker 暗号化を無効にできませんでした。

vtbl 5 HRESULT OfflineVolume()

IOCTL_VOLUME_OFFLINE 制御コードを使用してボリュームをオフラインにします。

戻り値

リターンコード	説明
S_OK	メソッドは正常に完了しました。

解説(Remarks)

ボリュームが既にオフラインの場合、OfflineVolume メソッドは S_OK を返します。

ボリュームがオフラインのとき、すべての読み取り、書き込み、および IOCTL 要求は ERROR_NOT_READY で失敗します。システムボリュームまたはブートボリュームをオフラインにすることはできません。

ボリュームがオンラインのとき、ボリュームに送信されたすべての要求は受け付けられます。

オンラインのボリュームがマウント解除された場合、次にボリュームを開く呼び出しによってボリュームがマウントされます。ボリュームをオフラインにすると、マウント解除されたボリュームが再びマウントされるのを防ぎます。ボリュームをマウント解除するには、IVdsVolumeMF::Dismount メソッドを使用します。

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