Win32 API 日本語リファレンス
ホームMedia.MediaPlayer › IWMPCdromBurn

IWMPCdromBurn

COM
IIDbd94dbeb-417f-4928-aa06-087d56ed9b59継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWMPCdromBurn インターフェースは、オーディオ CD の作成を管理するためのメソッドを提供します。

メソッド 14

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

vtbl 3 HRESULT isAvailable(LPWSTR bstrItem, VARIANT_BOOL* pIsAvailable)

isAvailable メソッドは、CD ドライブおよびメディアに関する情報を提供します。

bstrItemLPWSTRin

次のいずれかの値を格納する BSTR です。

説明
Burn ドライブが CD バーナーであること。
Disc ドライブに CD が入っていること。
Erase CD が消去可能であること。
Write CD が書き込み可能であること。
pIsAvailableVARIANT_BOOL*inout結果を示す VARIANT_BOOL へのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 4 HRESULT getItemInfo(LPWSTR bstrItem, LPWSTR* pbstrVal)

getItemInfo メソッドは、CD に対する指定した属性の値を取得します。

bstrItemLPWSTRin

次のいずれかの値を格納する BSTR です。

説明
AvailableTime CD で利用可能な時間を秒単位で取得します。
Blank CD が空かどうかを示す Boolean(文字列として表現)を取得します。
FreeSpace CD の空き領域をバイト単位で取得します。
TotalSpace CD の総容量をバイト単位で取得します。
pbstrValLPWSTR*inout返される値を受け取る BSTR へのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 5 HRESULT get_label(LPWSTR* pbstrLabel)

get_label メソッドは、CD のボリューム ラベル文字列を取得します。

pbstrLabelLPWSTR*inoutボリューム ラベル文字列を格納する BSTR へのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 6 HRESULT put_label(LPWSTR bstrLabel)

put_label メソッドは、CD ボリュームのラベル文字列を指定します。

bstrLabelLPWSTRinCD ボリュームのラベル文字列を格納する BSTR です。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

CD ラベルの格納方法により、CD のラベルは bstrLabel の長さよりも短くなる場合があります。bstrLabel が CD ラベルの最大長を超える場合、テキストは切り捨てられます。

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 7 HRESULT get_burnFormat(WMPBurnFormat* pwmpbf)

get_burnFormat メソッドは、書き込む CD の種類を示す値を取得します。

pwmpbfWMPBurnFormat*inout書き込む CD の種類を示す WMPBurnFormat 列挙体の値を受け取る変数へのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 8 HRESULT put_burnFormat(WMPBurnFormat wmpbf)

put_burnFormat メソッドは、書き込む CD の種類を指定します。

wmpbfWMPBurnFormatin書き込む CD の種類を指定する WMPBurnFormat 列挙体の値です。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 9 HRESULT get_burnPlaylist(IWMPPlaylist** ppPlaylist)

get_burnPlaylist メソッドは、CD に書き込む現在のプレイリストを取得します。

ppPlaylistIWMPPlaylist**out書き込むプレイリストの IWMPPlaylist ポインターを受け取る変数のアドレスです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 10 HRESULT put_burnPlaylist(IWMPPlaylist* pPlaylist)

put_burnPlaylist メソッドは、CD に書き込むプレイリストを指定します。

pPlaylistIWMPPlaylist*in書き込むプレイリストの IWMPPlaylist インターフェースへのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 11 HRESULT refreshStatus()

refreshStatus メソッドは、現在の書き込みプレイリストのステータス情報を更新します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

書き込みプレイリストを作成または変更した後、ステータス情報を読み取ったり CD を書き込んだりする前に、このメソッドを呼び出す必要があります。更新が必要かどうかは、get_burnState を呼び出して wmpbsRefreshStatusPending を確認することでテストできます。

ステータスの更新は同期操作です。つまり、現在の書き込みプレイリストが大きく、多数の変更が含まれている場合、このメソッドが戻るまでに長い時間がかかることがあります。

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 12 HRESULT get_burnState(WMPBurnState* pwmpbs)

get_burnState メソッドは、現在の書き込み状態を示す列挙値を取得します。

pwmpbsWMPBurnState*inout現在の状態を示す WMPBurnState 列挙体の値を受け取る変数へのポインターです。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 13 HRESULT get_burnProgress(INT* plProgress)

get_burnProgress メソッドは、CD 書き込みの進行状況を完了率(パーセント)として取得します。

plProgressINT*inout進行状況の値を受け取る long へのポインターです。進行状況の値は 0 から 100 の範囲です。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

進行状況の値は、ステージング操作を含む書き込みプロセス全体の完了率を表します。

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 14 HRESULT startBurn()

startBurn メソッドは、CD を書き込みます。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

このメソッドを呼び出す前に、書き込み状態は wmpbsReady または wmpbsStopped である必要があります。

このメソッドは、CD ドライブがバーナーでない場合、またはドライブ内のディスクが書き込み可能でない場合には機能しません。CD を書き込めるかどうかを判断するには、IWMPCdromBurn::isAvailable を使用してください。

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 15 HRESULT stopBurn()

stopBurn メソッドは、CD 書き込みプロセスを停止します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

vtbl 16 HRESULT erase()

erase メソッドは、現在の CD を消去します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドが成功しました。

解説(Remarks)

Windows Media Player 10 Mobile: このメソッドはサポートされていません。

このメソッドは、ドライブ内のディスクが書き換え可能でない場合には機能しません。CD を消去できるかどうかを判断するには、IWMPCdromBurn::isAvailable を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWMPCdromBurn "{BD94DBEB-417F-4928-AA06-087D56ED9B59}"
#usecom global IWMPCdromBurn IID_IWMPCdromBurn "{}"
#comfunc global IWMPCdromBurn_isAvailable       3 wstr,var
#comfunc global IWMPCdromBurn_getItemInfo       4 wstr,var
#comfunc global IWMPCdromBurn_get_label         5 var
#comfunc global IWMPCdromBurn_put_label         6 wstr
#comfunc global IWMPCdromBurn_get_burnFormat    7 var
#comfunc global IWMPCdromBurn_put_burnFormat    8 int
#comfunc global IWMPCdromBurn_get_burnPlaylist  9 sptr
#comfunc global IWMPCdromBurn_put_burnPlaylist  10 sptr
#comfunc global IWMPCdromBurn_refreshStatus     11
#comfunc global IWMPCdromBurn_get_burnState     12 var
#comfunc global IWMPCdromBurn_get_burnProgress  13 var
#comfunc global IWMPCdromBurn_startBurn         14
#comfunc global IWMPCdromBurn_stopBurn          15
#comfunc global IWMPCdromBurn_erase             16
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。