Microsoft Windows CE 3.0  

IMediaSample2::GetProperties

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Retrieves the properties of a media sample.

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. cbPropertiesspecifies the length of the data. This value can be NULL if cbPropertiesis NULL. Data conforms to the format of the AM_SAMPLE2_PROPERTIESstructure.

Return Values

Returns an HRESULTvalue 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 cbPropertiesto be less than the size of the AM_SAMPLE2_PROPERTIESstructure.

For performance reasons, the pMediaTypemember returned in AM_SAMPLE2_PROPERTIESis 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 Receivecall to which it was passed has been completed. Also, you don't need to free the pointer as you do with the pointer returned from the IMediaSample::GetMediaTypemethod.