FrameFilterImpl::addDataParam Method

Registers a data parameter than can be accessed using the methods of IFrameFilter.
Syntax:
protected:
    void addDataParam( const std::string& name, tFilterError (T::*getLenFunc)( size_t& length), tFilterError (T::*getFunc)( void*, size_t& ), tFilterError (T::*setFunc)( void*, size_t ) );
    void addDataParam( const std::wstring& name, tFilterError (T::*getLenFunc)( size_t& length), tFilterError (T::*getFunc)( void*, size_t& ), tFilterError (T::*setFunc)( void*, size_t ) );

Name Description
name

Name of the parameter. This string has to be passed to IFrameFilter::setData or IFrameFilter::getData to access the parameter.

getLenFunc

Name of a member function of the class derived from FrameFilterImpl. Has to take a reference to a size_t as its only parameter and return a tFilterError.

getFunc

Name of a member function of the class derived from FrameFilterImpl. Has to take a void* and a reference to a size_t as parameters and return a tFilterError.

setFunc

Name of a member function of the class derived from FrameFilterImpl. Has to take a void* and a size_t as parameters and return a tFilterError.

Remarks:

You should register all parameters of your frame filter in your constructor.

See also: FrameFilterImpl, FrameFilterImpl::addBoolParam, FrameFilterImpl::addLongParam, FrameFilterImpl::addFloatParam, FrameFilterImpl::addStringParam

<< FrameFilterImpl