IMediaSample2::GetProperties

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This 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 generic data buffer. cbProperties specifies the length of the data. This value can be NULL if cbProperties is NULL. Data conforms to the format of the AM_SAMPLE2_PROPERTIES structure.

Return Value

Returns an HRESULT value that depends on the implementation of the interface. The default implementation returns S_OK.

Remarks

You can use this method to return only some of the sample properties by setting cbProperties to be less than the size of the AM_SAMPLE2_PROPERTIES structure.

For performance reasons, the pMediaType member returned in AM_SAMPLE2_PROPERTIES is merely a pointer to the data stored in the media sample. Therefore, the pointer will not necessarily be valid after the sample has been passed to another filter or after the Receive call to which it was passed has been completed. Also, you do not need to free the pointer as you do with the pointer returned from the IMediaSample::GetMediaType method.

Requirements

See Also

Reference

IMediaSample2 Interface