ホーム › Storage.Imapi › IDiscFormat2Erase

IDiscFormat2Erase

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID27354156-8f64-5b0f-8f00-5d77afbe261e継承元IDiscFormat2呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl12

公式ドキュメント

このインターフェイスを使用して、ディスクからデータを消去します。

解説(Remarks)

スクリプトで MsftDiscFormat2Erase オブジェクトを作成するには、CreateObject の呼び出し時にプログラム識別子として IMAPI2.MsftDiscFormat2Erase を指定します。

メソッド 8

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 12 HRESULT put_Recorder(IDiscRecorder2* value)

消去操作で使用する記録デバイスを設定します。

value

IDiscRecorder2*

消去操作で使用する記録デバイスを示す IDiscRecorder2 インターフェイスです。

戻り値

成功時には S_OK が返されますが、実装によっては他の成功コードが返されることもあります。操作が失敗した場合は次のエラーコードが返されるのが一般的ですが、返される可能性のあるエラー値はこれらに限られません。

解説(Remarks)

レコーダーは、このインターフェイスで定義されるフォーマットと互換性がある必要があります。互換性を確認するには、IDiscFormat2::IsRecorderSupported メソッドを呼び出します。

vtbl 13 HRESULT get_Recorder(IDiscRecorder2** value)

消去操作で使用する記録デバイスを取得します。

value

IDiscRecorder2**

out

消去操作で使用する記録デバイスを示す IDiscRecorder2 インターフェイスです。

戻り値

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003

vtbl 14 HRESULT put_FullErase(VARIANT_BOOL value)

ディスク消去の品質を指定します。(Put)

value

VARIANT_BOOL

メディア全体を少なくとも 1 回上書きしてディスクを完全に消去するには、VARIANT_TRUE を設定します。

ディスク全体ではなくディレクトリトラックのみを上書きするには、VARIANT_FALSE を設定します。このオプションは、完全消去オプションよりも所要時間が短くなります。

既定値は VARIANT_FALSE です。

戻り値

vtbl 15 HRESULT get_FullErase(VARIANT_BOOL* value)

ディスク消去の品質を指定します。(Get)

value

VARIANT_BOOL*

out

消去操作がメディア全体を少なくとも 1 回上書きしてディスクを完全に消去する場合は VARIANT_TRUE です。

消去操作がディスク全体ではなくディレクトリトラックのみを上書きする場合は VARIANT_FALSE です。このオプションは、完全消去オプションよりも所要時間が短くなります。

戻り値

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003

vtbl 16 HRESULT get_CurrentPhysicalMediaType(IMAPI_MEDIA_PHYSICAL_TYPE* value)

ディスクデバイス内のメディアの種類を取得します。(IDiscFormat2Erase.get_CurrentPhysicalMediaType)

value

IMAPI_MEDIA_PHYSICAL_TYPE*

out

ディスクデバイス内のメディアの種類です。指定できる値については、IMAPI_MEDIA_PHYSICAL_TYPE 列挙型を参照してください。

戻り値

戻り値	説明
E_IMAPI_RECORDER_REQUIRED	この要求には、現在のディスクレコーダーが選択されている必要があります。値: 0xC0AA0003
E_POINTER	ポインターが無効です。メモこの値は NULL ポインターを示すものではありません。値: 0x80004003
E_FAIL	原因不明の失敗です。値: 0x80004005
E_OUTOFMEMORY	必要なメモリの割り当てに失敗しました。値: 0x8007000E
E_IMAPI_RECORDER_COMMAND_TIMEOUT	デバイスがタイムアウト期間内にコマンドを受け付けませんでした。デバイスが不整合な状態に陥っているか、コマンドのタイムアウト値を大きくする必要がある可能性があります。値: 0xC0AA020D
E_IMAPI_RECORDER_INVALID_RESPONSE_FROM_DEVICE	デバイスがコマンドに対して予期しないデータまたは無効なデータを報告しました。値: 0xC0AA02FF
E_IMAPI_RECORDER_MEDIA_UPSIDE_DOWN	メディアが裏返しに挿入されています。値: 0xC0AA0204
E_IMAPI_RECORDER_MEDIA_BECOMING_READY	ドライブが準備中であることを報告しました。しばらくしてから要求を再試行してください。値: 0xC0AA0205
E_IMAPI_RECORDER_MEDIA_NO_MEDIA	デバイスにメディアが入っていません。値: 0xC0AA0202
E_IMAPI_RECORDER_MEDIA_FORMAT_IN_PROGRESS	メディアは現在フォーマット中です。フォーマットが完了するまで待ってから、メディアを使用してください。値: 0xC0AA0206
E_IMAPI_RECORDER_MEDIA_BUSY	ドライブが、書き込みの完了処理などの長時間実行される操作を実行中であることを報告しました。ドライブは長時間使用できない可能性があります。値: 0xC0AA0207
E_IMAPI_LOSS_OF_STREAMING	ドライブが書き込みを継続できる速さでデータを受け取れなかったため、書き込みに失敗しました。ソースデータをローカルコンピューターに移動する、書き込み速度を下げる、または「バッファーアンダーランフリー」設定を有効にすることで、この問題が解決する場合があります。値: 0xC0AA0300
E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE	メディアに互換性がないか、物理フォーマットが不明です。値: 0xC0AA0203
E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT	DVD 構造が存在しません。互換性のないドライブまたはメディアを使用したことが原因の可能性があります。値: 0xC0AA020E
E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE	要求されたモードページ (およびその種類) が存在しないと、デバイスが報告しました。値: 0xC0AA0201
E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS	MODE SELECT コマンドのモードページで指定されたパラメーターの組み合わせがサポートされていないと、ドライブが報告しました。値: 0xC0AA0208
E_IMAPI_RECORDER_MEDIA_WRITE_PROTECTED	メディアが書き込み保護されていると、ドライブが報告しました。値: 0xC0AA0209
E_IMAPI_RECORDER_MEDIA_SPEED_MISMATCH	メディアの速度がデバイスと互換性がありません。デバイスがサポートする速度範囲より高速または低速のメディアを使用したことが原因の可能性があります。値: 0xC0AA020F
HRESULT_FROM_WIN32(ERROR_INVALID_HANDLE)	指定されたハンドルが無効です。値: 6
HRESULT_FROM_WIN32(ERROR_DEV_NOT_EXIST)	指定されたネットワークリソースまたはデバイスは既に利用できません。値: 55
E_IMAPI_RECORDER_LOCKED	前回の操作でこのレコーダーに関連付けられたデバイスが排他的にロックされているため、この操作は失敗しました。値: 0xC0AA0210

vtbl 17 HRESULT put_ClientName(LPWSTR value)

クライアントのフレンドリ名を設定します。(IDiscFormat2Erase.put_ClientName)

value

LPWSTR

クライアントアプリケーションの名前です。

戻り値

戻り値	説明
E_OUTOFMEMORY	必要なメモリの割り当てに失敗しました。値: 0x8007000E
E_INVALIDARG	1 つ以上の引数が無効です。値: 0x80070057

解説(Remarks)

この名前は、書き込み操作がデバイスへの排他アクセスを要求するときに使用されます。IDiscRecorder2::get_ExclusiveAccessOwner プロパティには、ロックを保持しているクライアントの名前が格納されます。

消去操作中に CDROM デバイスへの読み取り/書き込みアクセス権を持つアプリケーションであれば、IOCTL_CDROM_EXCLUSIVE_ACCESS (query) 制御コード (Microsoft Windows Driver Development Kit (DDK) を参照) を使用してこの名前を取得できるため、このインターフェイスを使用してメディアを消去しているプログラムを識別できる名前にすることが重要です。名前に使用できる文字は、IOCTL_CDROM_EXCLUSIVE_ACCESS 制御コードで要求される文字セットに制限されます。

vtbl 18 HRESULT get_ClientName(LPWSTR* value)

クライアントのフレンドリ名を取得します。(IDiscFormat2Erase.get_ClientName)

value

LPWSTR*

out

クライアントアプリケーションの名前です。

戻り値

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003
E_OUTOFMEMORY	必要なメモリの割り当てに失敗しました。値: 0x8007000E

vtbl 19 HRESULT EraseMedia()

アクティブなディスクレコーダー内のメディアを消去します。

戻り値

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003
E_FAIL	原因不明の失敗です。値: 0x80004005
E_OUTOFMEMORY	必要なメモリの割り当てに失敗しました。値: 0x8007000E
E_IMAPI_RECORDER_COMMAND_TIMEOUT	デバイスがタイムアウト期間内にコマンドを受け付けませんでした。デバイスが不整合な状態に陥っているか、コマンドのタイムアウト値を大きくする必要がある可能性があります。値: 0xC0AA020D
E_IMAPI_RECORDER_INVALID_RESPONSE_FROM_DEVICE	デバイスがコマンドに対して予期しないデータまたは無効なデータを報告しました。値: 0xC0AA02FF
E_IMAPI_RECORDER_MEDIA_UPSIDE_DOWN	メディアが裏返しに挿入されています。値: 0xC0AA0204
E_IMAPI_RECORDER_MEDIA_BECOMING_READY	ドライブが準備中であることを報告しました。しばらくしてから要求を再試行してください。値: 0xC0AA0205
E_IMAPI_RECORDER_MEDIA_NO_MEDIA	デバイスにメディアが入っていません。値: 0xC0AA0202
E_IMAPI_RECORDER_MEDIA_FORMAT_IN_PROGRESS	メディアは現在フォーマット中です。フォーマットが完了するまで待ってから、メディアを使用してください。値: 0xC0AA0206
E_IMAPI_RECORDER_MEDIA_BUSY	ドライブが、書き込みの完了処理などの長時間実行される操作を実行中であることを報告しました。ドライブは長時間使用できない可能性があります。値: 0xC0AA0207
E_IMAPI_LOSS_OF_STREAMING	ドライブが書き込みを継続できる速さでデータを受け取れなかったため、書き込みに失敗しました。ソースデータをローカルコンピューターに移動する、書き込み速度を下げる、または「バッファーアンダーランフリー」設定を有効にすることで、この問題が解決する場合があります。値: 0xC0AA0300
E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE	メディアに互換性がないか、物理フォーマットが不明です。値: 0xC0AA0203
E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT	DVD 構造が存在しません。互換性のないドライブまたはメディアを使用したことが原因の可能性があります。値: 0xC0AA020E
E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE	要求されたモードページ (およびその種類) が存在しないと、デバイスが報告しました。値: 0xC0AA0201
E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS	MODE SELECT コマンドのモードページで指定されたパラメーターの組み合わせがサポートされていないと、ドライブが報告しました。値: 0xC0AA0208
E_IMAPI_RECORDER_MEDIA_WRITE_PROTECTED	メディアが書き込み保護されていると、ドライブが報告しました。値: 0xC0AA0209
E_IMAPI_RECORDER_MEDIA_SPEED_MISMATCH	メディアの速度がデバイスと互換性がありません。デバイスがサポートする速度範囲より高速または低速のメディアを使用したことが原因の可能性があります。値: 0xC0AA020F
HRESULT_FROM_WIN32(ERROR_INVALID_HANDLE)	指定されたハンドルが無効です。値: 6
HRESULT_FROM_WIN32(ERROR_DEV_NOT_EXIST)	指定されたネットワークリソースまたはデバイスは既に利用できません。値: 55
E_IMAPI_RECORDER_LOCKED	前回の操作でこのレコーダーに関連付けられたデバイスが排他的にロックされているため、この操作は失敗しました。値: 0xC0AA0210
E_IMAPI_ERASE_MEDIA_IS_NOT_SUPPORTED	現在のメディアの種類はサポートされていません。値: 0xC0AA0909
E_IMAPI_ERASE_DRIVE_FAILED_SPINUP_COMMAND	ドライブが START UNIT (スピンアップ) コマンドに対してエラーを返しました。手動での対処が必要な場合があります。値: 0x80AA0908
E_IMAPI_ERASE_TOOK_LONGER_THAN_ONE_HOUR	ドライブが 1 時間以内に消去を完了しませんでした。正常な動作を再開するには、電源の入れ直し、メディアの取り出し、またはその他の手動での対処が必要になる場合があります。メモ現時点では、IDiscFormat2Erase インターフェイスを使用した CD-RW または DVD-RW メディアの消去が、メディアの不良が原因で失敗した場合にも、この値が返されます。値: 0x80AA0906

解説(Remarks)

メディアを同期的に消去します。進行状況は、DDiscFormat2EraseEvents 型の登録済みイベントを呼び出すことで通知できます。

このメソッドを呼び出す前に、次のメソッドを呼び出しておく必要があります。

また、既定値がアプリケーションに適さない場合は、IDiscFormat2Erase::put_FullErase メソッドの呼び出しも検討してください。

このメソッドは同期的です。消去操作の進行状況を把握するには、DDiscFormat2EraseEvents インターフェイスを実装する必要があります。スクリプトでイベントハンドラーを実装する方法を示す例については、「Monitoring Progress With Events」を参照してください。

現時点では、IDiscFormat2Erase インターフェイスを使用した CD-RW または DVD-RW メディアの消去が、メディアの不良またはドライブの障害が原因で失敗した場合にも、E_IMAPI_ERASE_TOOK_LONGER_THAN_ONE_HOUR 値が返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDiscFormat2Erase "{27354156-8F64-5B0F-8F00-5D77AFBE261E}"
#usecom global IDiscFormat2Erase IID_IDiscFormat2Erase "{}"
#comfunc global IDiscFormat2Erase_put_Recorder                  12 sptr
#comfunc global IDiscFormat2Erase_get_Recorder                  13 sptr
#comfunc global IDiscFormat2Erase_put_FullErase                 14 int
#comfunc global IDiscFormat2Erase_get_FullErase                 15 var
#comfunc global IDiscFormat2Erase_get_CurrentPhysicalMediaType  16 var
#comfunc global IDiscFormat2Erase_put_ClientName                17 wstr
#comfunc global IDiscFormat2Erase_get_ClientName                18 var
#comfunc global IDiscFormat2Erase_EraseMedia                    19
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IDiscFormat2Erase "{27354156-8F64-5B0F-8F00-5D77AFBE261E}"
#usecom global IDiscFormat2Erase IID_IDiscFormat2Erase "{}"
#comfunc global IDiscFormat2Erase_put_Recorder                  12 sptr
#comfunc global IDiscFormat2Erase_get_Recorder                  13 sptr
#comfunc global IDiscFormat2Erase_put_FullErase                 14 int
#comfunc global IDiscFormat2Erase_get_FullErase                 15 sptr
#comfunc global IDiscFormat2Erase_get_CurrentPhysicalMediaType  16 sptr
#comfunc global IDiscFormat2Erase_put_ClientName                17 wstr
#comfunc global IDiscFormat2Erase_get_ClientName                18 sptr
#comfunc global IDiscFormat2Erase_EraseMedia                    19
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。