IMemAllocator::GetProperties method (strmif.h)

Article
02/22/2024

[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 GetProperties method retrieves the number of buffers that the allocator will create, and the buffer properties.

Syntax

HRESULT GetProperties(
  [out] ALLOCATOR_PROPERTIES *pProps
);

Parameters

[out] pProps

Pointer to an ALLOCATOR_PROPERTIES structure that receives the allocator properties.

Return value

Returns S_OK if successful, or an HRESULT value indicating the cause of the error.

Remarks

Calls to this method might not succeed until the IMemAllocator::Commit method is called.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib