IVdsAdvancedDisk::Clean メソッド (vds.h)

[Windows 8とWindows Server 2012以降、仮想ディスク サービス COM インターフェイスは Windows Storage Management API に置き換えられます。

パーティション情報を削除し、ベーシック ディスクまたはダイナミック ディスクを初期化解除します。

Windows Server 2003: Clean メソッドは、リムーバブル デバイスではサポートされていません。

構文

HRESULT Clean(
  [in]  BOOL      bForce,
  [in]  BOOL      bForceOEM,
  [in]  BOOL      bFullClean,
  [out] IVdsAsync **ppAsync
);

パラメーター

[in] bForce

TRUE の場合は、データ ボリュームまたは ESP パーティションを含むディスクをクリーンアップします。

[in] bForceOEM

TRUE の場合は、次の表に示す既知の OEM パーティションを含む MBR ベースのディスクをクリーンアップするか、OEM パーティションを含む GPT ベースのディスクをクリーンアップします。 OEM パーティションには、GPT ベースのディスクに GPT_ATTRIBUTE_PLATFORM_REQUIRED フラグが設定されています。

[in] bFullClean

TRUE の場合は、各セクターのデータをゼロに置き換えてディスク全体をクリーンアップします。それ以外の場合、このメソッドはディスク上の最初と最後のメガバイトのみをクリーンアップします。

[out] ppAsync

戻り時に VDS が初期化する IVdsAsync インターフェイス ポインターへのポインターのアドレス。 呼び出し元はインターフェイスを解放する必要があります。 操作の状態を取り消す、待機する、またはクエリを実行するには、このポインターを使用します。

戻り値

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

解説

このメソッドを呼び出す前に、呼び出し元は、ボリュームごとに IVdsVolumeMF::D ismount を呼び出して、ディスク上のマウントされたボリュームをマウント解除する必要があります。

ディスク上のすべてのデータ ボリューム、既知の OEM パーティション、ESP パーティションを最初に削除しない限り、 bForce パラメーター、 bForceOEM パラメーター、またはその両方をこのメソッドで使用します。 この要件では、MSR、LDM メタデータ パーティション、不明な OEM パーティションなどのメタデータ パーティションは除外されます。

Windows Server 2003: Clean メソッドは、リムーバブル デバイスではサポートされていません。

実装者は、呼び出しが非同期操作を開始するかどうかに関係なく、このメソッドの IVdsAsync インターフェイスへのポインターを返す必要があります。

要件

関連項目

Disk オブジェクト

IVdsAdvancedDisk

IVdsAsync