IMediaSample2::GetProperties

Windows CE .NET

This method 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. 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 Values

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

DirectShow applications and DirectShow filters have different include file and link library requirements. See Setting Up the Build Environment for more information.

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.

See Also

IMediaSample2 Interface


Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.

Show: