IFrameFilter::getDataLength Method |
|
Returns the length of the blob that can be read using getData.
|
| Syntax: |
|
tFilterError getDataLength( const std::string& name, size_t& length );
tFilterError getDataLength( const std::wstring& name, size_t& length );
|
|
|
|
|
| name |
|
The name of the data parameter which size is determined.
|
| length |
|
This parameter receives the required size of the buffer for the next call to getData.
|
|
| Return Value: |
|
A member of the tFilterError enumeration:
|
|
| 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 |