CBaseAllocator::Decommit

  • Article
 
Microsoft DirectShow 9.0

CBaseAllocator::Decommit

The Decommit method decommits the allocator. This method implements the IMemAllocator::Decommit method.

Syntax

  HRESULT Decommit(void);

Return Value

Returns S_OK.

Remarks

After this method is called, calls to the CBaseAllocator::GetBuffer method will fail. As samples are released, they get returned to the free list. When the last sample is returned, the allocator calls the CBaseAllocator::Free method, which releases the allocated memory. (In the base class, Free is a pure virtual method.)

In addition, this method releases any threads that are blocked on GetBuffer calls. The calls to GetBuffer fail.

Requirements

**  Header:** Declared in Amfilter.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also