IFrameFilter::getData Method

データ型パラメータを読み取ります。データ型パラメータはユーザーにフィルタのRawのデータを提供するものです。

構文

tFilterError getData( const std::string& name, void* pData, size_t& length );
tFilterError getData( const std::wstring& name, void* pData, size_t& length );
パラメータ 説明
name 読み取るデータ型パラメータの名前です。
pData データを受け取るバッファへのポインタです。最低でもlength分のバイト長である必要があります。
length pDataがポイントしているバッファの長さ。

戻り値

tFilterErrorクラスライブラリリファレンス＞エニュメレーション＞tFilterError エニュメレーションのメンバ:

値 説明
eNO_ERROR データの読み取りは正常に行われました。
ePARAM_NOT_FOUND フィルタはnameで指定されたパラメータを所有していません。
getAvailableParametersクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::getAvailableParameters Methodを使用して有効なパラメータの一覧を取得してください。
eINCOMPATIBLE_PARAM_VALUE nameはデータ型パラメータではありません。
getAvailableParametersクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::getAvailableParameters Methodを使用して有効なパラメータとその型の一覧を取得してください。
eINVALID_FILTER_STATE 読み取り不可能な状態にあるためフィルタがデータを返せません。例：ライブモードでない時。

備考

setDataへのコールはすべてbeginParamTransferクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::beginParamTransfer Methodと endParamTransferクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::endParamTransfer Method の間に入れる必要あります。

関連項目

IFrameFilterクラスライブラリリファレンス＞クラス＞IFrameFilter, IFrameFilter::setDataクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::setParameter Method, IFrameFilter::getDataLengthクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::getDataLength Method, IFrameFilter::getAvailableParametersクラスライブラリリファレンス＞クラス＞IFrameFilter＞IFrameFilter::getAvailableParameters Method