IMediaSample2::GetProperties

  • Articolo
 
Microsoft DirectShow 9.0

IMediaSample2::GetProperties

The GetProperties method retrieves the properties of a media sample.

Syntax

  HRESULT GetProperties(
  DWORD cbProperties,
  BYTE *pbProperties
);

Parameters

cbProperties

[in] Length of property data to retrieve, in bytes.

pbProperties

[out] Pointer to a buffer of size cbProperties.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK Success.
E_POINTER NULL pointer argument.

Remarks

The retrieved data conforms to the format of the AM_SAMPLE2_PROPERTIES structure. You can retrieve a subset of the sample properties by setting cbProperties to a value less than the size of the AM_SAMPLE2_PROPERTIES structure.

For efficiency, the pMediaType member returned in AM_SAMPLE2_PROPERTIES is a pointer to the data stored in the media sample, not a copy of that data. The pointer may become invalid after the sample is passed to another filter, or after the input pin's IMemInputPin::Receive method has completed. Also, do not free the pointer or delete the media type.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also