IC Imaging Control C++

IFrameFilter::getData Method

IFrameFilter::getData Method

Reads a data parameter. A data parameter allows the the filter to provide a raw block of data to the user.
tFilterError getData( const std::string& name, void* pData, size_t& length );
tFilterError getData( const std::wstring& name, void* pData, size_t& length );

Parameter Description

The name of the data parameter to be read.


A pointer to a buffer that receives the data. Has to be at least length bytes in length.


Length of the buffer pointed to by pData.

Return Value:

A member of the tFilterError enumeration:

Value Description
eNO_ERROR The data was read successfully.
ePARAM_NOT_FOUND The filter does not have a parameter with the specified name. To obtain a list with the valid parameters, use getAvailableParameters.
eINCOMPATIBLE_PARAM_VALUE name is not a data parameter. To obtain a list with the valid parameters and its types, use getAvailableParameters.
eINVALID_FILTER_STATE The filter could return the data, because it is in a state that prevents the data from being read, e.g. not in live mode.

All calls to setData have to be inside a beginParamTransfer /endParamTransfer block.

See also: IFrameFilter, IFrameFilter::setData, IFrameFilter::getDataLength, IFrameFilter::getAvailableParameters

<< IFrameFilter

Get in touch with us

About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, video converters and embedded vision components for factory automation, quality assurance, medicine, science, security and a variety of other markets.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE, MIPI interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

ISO 9001:2015 certified MVTEC | Edge AI + Vision Alliance | EMVA

Contact us