CImageAllocator.CheckSizes method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The CheckSizes method checks allocator properties against the current media type.

Syntax

HRESULT CheckSizes(
   ALLOCATOR_PROPERTIES *pRequest
);

Parameters

pRequest

Pointer to an ALLOCATOR_PROPERTIES structure that describes the requested allocator properties.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	The requested properties are compatible with the media type.
E_INVALIDARG	The requested properties are not compatible with the media type.
VFW_E_NOT_CONNECTED	The owning pin is not connected.

Remarks

When the method returns, if the return value is S_OK, the cbBuffer member of pRequest contains the actual buffer size. This might be larger than the requested size, but will never be smaller.

Requirements

Requirement	Value
Header	Winutil.h (include Streams.h)
Library	Strmbase.lib (retail builds); Strmbasd.lib (debug builds)

See also

CImageAllocator Class