FrameFilterImpl::addStringParam Method

Registers a string parameter than can be accessed using the methods of IFrameFilter.

Syntax:

protected:
    void addStringParam( const std::string& name, tFilterError (T::*getFunc)( _bstr_t& ), tFilterError (T::*setFunc)( _bstr_t ) );
    void addStringParam( const std::wstring& name, tFilterError (T::*getFunc)( _bstr_t& ), tFilterError (T::*setFunc)( _bstr_t ) );

Name		Description


name		Name of the parameter. This string has to be passed to IFrameFilter::setParameter or IFrameFilter::getParameter to access the parameter.
getFunc		Name of a member function of the class derived from FrameFilterImpl. Has to take a reference to a _bstr_t as its only parameter and return a tFilterError.
setFunc		Name of a member function of the class derived from FrameFilterImpl. Has to take a _bstr_t as its only parameter and return a tFilterError.

Remarks:

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

Example:

For an example how to register a parameter, see addFloatParam.

<< FrameFilterImpl