Edit

CMediaSample.GetProperties method

  • Article

[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 properties of the sample. This method implements the IMediaSample2::GetProperties method.

Syntax

HRESULT GetProperties(
   DWORD cbProperties,
   BYTE  *pbProperties
);

Parameters

cbProperties

Length of property data to retrieve, in bytes.

pbProperties

Pointer to a buffer of size cbProperties.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_OK
 Success.
E_POINTER
 NULL pointer argument.

Requirements

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

See also

CMediaSample Class