ID2D1CommandList::Stream メソッド (d2d1_1.h)

指定したコマンド シンクにコマンド リストの内容をストリーミングします。

構文

HRESULT Stream(
  [in] ID2D1CommandSink *sink
);

パラメーター

[in] sink

型: ID2D1CommandSink*

コマンド リストのストリーミング先となるシンク。

戻り値

型: HRESULT

メソッドが成功した場合は、S_OKを返します。 失敗した場合は、HRESULT エラー コードが返されます。

戻り値は、EndDraw メソッドを介してコマンド シンク実装が返すエラーを示します。

備考

コマンド シンクは、API の任意の呼び出し元によって実装できます。

コマンド リストがターゲットとして選択されている間に呼び出し元がデザイン時のエラー呼び出しを行うと、コマンド リストはエラー状態になります。 ストリーム呼び出しは、渡されたシンクへの呼び出しを行わずに失敗します。

使用例:

Class MyCommandSink : public ID2D1CommandSink
{
public:
    // All of the ID2D1CommandSink methods implemented here.
};

HRESULT
StreamToMyCommandSink(
    __in ID2D1CommandList *pCommandList 
    )
{
    HRESULT hr = S_OK;
    
    MyCommandSink *pCommandSink = new MyCommandSink();
    hr = pCommandSink ? S_OK : E_OUTOFMEMORY;

    if (SUCCEEDED(hr))
    {
        // Receive the contents of the command sink streamed to the sink.
        hr = pCommandList->Stream(pCommandSink);
    }

    SafeRelease(&pCommandSink);
   
    return hr;

}

必要条件

関連項目

ID2D1CommandList