IC Imaging Control C++

IFrameFilter::getDataLength Method

IFrameFilter::getDataLength Method

Returns the length of the blob that can be read using getData.
tFilterError getDataLength( const std::string& name, size_t& length );
tFilterError getDataLength( const std::wstring& name, size_t& length );

Parameter Description

The name of the data parameter which size is determined.


This parameter receives the required size of the buffer for the next call to getData.

Return Value:

A member of the tFilterError enumeration:

Value Description
eNO_ERROR The data size 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 size, because it is in a state that prevents the data size from being determined, e.g. not in live mode.
See also: IFrameFilter, IFrameFilter::getData, 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, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

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

Automated Imaging Association ISO 9001:2015 certified

Contact us