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

IDiscFormat2

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID27354152-8f64-5b0f-8f00-5d77afbe261e継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

これは基底インターフェースです。このインターフェースを継承する次のインターフェース IDiscFormat2Data、IDiscFormat2Erase、IDiscFormat2TrackAtOnce、IDiscFormat2RawCD を使用してください。

メソッド 5

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

vtbl 7 HRESULT IsRecorderSupported(IDiscRecorder2* recorder, VARIANT_BOOL* value)

レコーダーが指定された形式をサポートしているかどうかを判定します。

recorderIDiscRecorder2*inテスト対象のレコーダーの IDiscRecorder2 インターフェース。
valueVARIANT_BOOL*outレコーダーが指定された形式をサポートしている場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE になります。

戻り値

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

戻り値 説明
E_POINTER
ポインターが有効ではありません。

値: 0x80004003

解説(Remarks)

IDiscFormat2RawCD インターフェースで実装されている場合、レコーダーが指定された形式をサポートしていないときは、このメソッドは E_IMAPI_DF2RAW_MEDIA_IS_NOT_SUPPORTED を返します。この特定のケースでは、この値はエラーが発生したことを示すのではなく、操作が成功した結果を表す点に注意することが重要です。

vtbl 8 HRESULT IsCurrentMediaSupported(IDiscRecorder2* recorder, VARIANT_BOOL* value)

サポートされているレコーダーに現在挿入されているメディアが、指定された形式をサポートしているかどうかを判定します。

recorderIDiscRecorder2*inテスト対象のレコーダーの IDiscRecorder2 インターフェース。
valueVARIANT_BOOL*out

レコーダー内のメディアが指定された形式をサポートしている場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE になります。

注意 VARIANT_TRUE は、IsDiscRecorderSupported の結果も VARIANT_TRUE であることを意味します。

戻り値

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

戻り値 説明
E_POINTER
ポインターが有効ではありません。

値: 0x80004003

E_IMAPI_RECORDER_MEDIA_NO_MEDIA
デバイスにメディアがありません。

値: 0xC0AA0202

注意 現在、Windows Vista ではデバイスにメディアが存在しない場合に S_OKVARIANT_FALSE が返されますが、Windows 7 では E_IMAPI_RECORDER_MEDIA_NO_MEDIAVARIANT_FALSE が返されます。
vtbl 9 HRESULT get_MediaPhysicallyBlank(VARIANT_BOOL* value)

現在のメディアが物理的にブランクであるとドライブが報告しているかどうかを判定します。

valueVARIANT_BOOL*outディスクが物理的にブランクである場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE になります。

戻り値

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

戻り値 説明
E_POINTER
ポインターが有効ではありません。

値: 0x80004003

E_FAIL
不特定のエラーです。

値: 0x80004005

E_OUTOFMEMORY
必要なメモリの割り当てに失敗しました。

値: 0x8007000E

E_INVALIDARG
1 つ以上の引数が有効ではありません。

値: 0x80070057

E_IMAPI_RECORDER_FEATURE_IS_NOT_CURRENT
要求された feature page はサポートされていますが、current としてマークされていません。

値: 0xC0AA020B

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
ドライブが書き込みを継続できるだけの速さでデータを受け取れなかったため、書き込みに失敗しました。ソースデータをローカルコンピューターに移動する、書き込み速度を下げる、または「buffer underrun free」設定を有効にすることで、この問題が解決する場合があります。

値: 0xC0AA0300

E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE
メディアに互換性がないか、物理フォーマットが不明です。

値: 0xC0AA0203

E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT
DVD 構造が存在しません。互換性のないドライブまたはメディアを使用していることが原因の可能性があります。

値: 0xC0AA020E

E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE
要求された mode page (およびその型) が存在しないとデバイスが報告しました。

値: 0xC0AA0201

E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS
MODE SELECT コマンドの mode page で指定されたパラメーターの組み合わせがサポートされていないとドライブが報告しました。

値: 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 10 HRESULT get_MediaHeuristicallyBlank(VARIANT_BOOL* value)

ヒューリスティックを用いて、メディアがブランクかどうかの判定を試みます (主に DVD+RW および DVD-RAM メディア向け)。

valueVARIANT_BOOL*outディスクがブランクである可能性が高い場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE になります。

戻り値

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

戻り値 説明
E_POINTER
ポインターが有効ではありません。

値: 0x80004003

E_FAIL
不特定のエラーです。

値: 0x80004005

E_OUTOFMEMORY
必要なメモリの割り当てに失敗しました。

値: 0x8007000E

E_INVALIDARG
1 つ以上の引数が有効ではありません。

値: 0x80070057

E_IMAPI_RECORDER_FEATURE_IS_NOT_CURRENT
要求された feature page はサポートされていますが、current としてマークされていません。

値: 0xC0AA020B

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
ドライブが書き込みを継続できるだけの速さでデータを受け取れなかったため、書き込みに失敗しました。ソースデータをローカルコンピューターに移動する、書き込み速度を下げる、または「buffer underrun free」設定を有効にすることで、この問題が解決する場合があります。

値: 0xC0AA0300

E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE
メディアに互換性がないか、物理フォーマットが不明です。

値: 0xC0AA0203

E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT
DVD 構造が存在しません。互換性のないドライブまたはメディアを使用していることが原因の可能性があります。

値: 0xC0AA020E

E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE
要求された mode page (およびその型) が存在しないとデバイスが報告しました。

値: 0xC0AA0201

E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS
MODE SELECT コマンドの mode page で指定されたパラメーターの組み合わせがサポートされていないとドライブが報告しました。

値: 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

解説(Remarks)

このメソッドは、たとえばデバイス上にマウントされたファイルシステムの有無の確認、ディスクの先頭と末尾の 2MB がゼロで埋められているかの検証、その他メディア固有のチェックを行います。これらのチェックは、物理的にブランク状態へ消去できないメディアについて、ファイルが記録されている可能性があるかどうかを判断するのに役立ちます。

ディスクがブランクであることを確実に確認するには、IDiscFormat2::get_MediaPhysicallyBlank メソッドを呼び出してください。

vtbl 11 HRESULT get_SupportedMediaTypes(SAFEARRAY** value)

IDiscFormat2 インターフェースの現在の実装でサポートされるメディアの種類を取得します。

valueSAFEARRAY**outIDiscFormat2 インターフェースの現在の実装でサポートされるメディアの種類の一覧。配列の各要素は VT_I4 型の VARIANT です。VARIANTlVal メンバーにメディアの種類が格納されます。メディアの種類の一覧については、IMAPI_MEDIA_PHYSICAL_TYPE 列挙型を参照してください。

戻り値

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

戻り値 説明
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
ドライブが書き込みを継続できるだけの速さでデータを受け取れなかったため、書き込みに失敗しました。ソースデータをローカルコンピューターに移動する、書き込み速度を下げる、または「buffer underrun free」設定を有効にすることで、この問題が解決する場合があります。

値: 0xC0AA0300

E_IMAPI_RECORDER_MEDIA_INCOMPATIBLE
メディアに互換性がないか、物理フォーマットが不明です。

値: 0xC0AA0203

E_IMAPI_RECORDER_DVD_STRUCTURE_NOT_PRESENT
DVD 構造が存在しません。互換性のないドライブまたはメディアを使用していることが原因の可能性があります。

値: 0xC0AA020E

E_IMAPI_RECORDER_NO_SUCH_MODE_PAGE
要求された mode page (およびその型) が存在しないとデバイスが報告しました。

値: 0xC0AA0201

E_IMAPI_RECORDER_INVALID_MODE_PARAMETERS
MODE SELECT コマンドの mode page で指定されたパラメーターの組み合わせがサポートされていないとドライブが報告しました。

値: 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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDiscFormat2 "{27354152-8F64-5B0F-8F00-5D77AFBE261E}"
#usecom global IDiscFormat2 IID_IDiscFormat2 "{}"
#comfunc global IDiscFormat2_IsRecorderSupported          7 sptr,var
#comfunc global IDiscFormat2_IsCurrentMediaSupported      8 sptr,var
#comfunc global IDiscFormat2_get_MediaPhysicallyBlank     9 var
#comfunc global IDiscFormat2_get_MediaHeuristicallyBlank  10 var
#comfunc global IDiscFormat2_get_SupportedMediaTypes      11 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。