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.
A version of this page is also available for
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. 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 Value

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 do not need to free the pointer as you do with the pointer returned from the IMediaSample::GetMediaTypemethod.

Requirements

Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment,
Version 2.12 requires DXPAK 1.0 or later

See Also