Export (0) Print
Expand All

IMediaSample2::GetProperties method

The GetProperties method retrieves the properties of a media sample.

Syntax


HRESULT GetProperties(
  [in]   DWORD cbProperties,
  [out]  BYTE *pbProperties
);

Parameters

cbProperties [in]

Length of property data to retrieve, in bytes.

pbProperties [out]

Pointer to a buffer of size cbProperties.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IMediaSample2 Interface

 

 

Community Additions

ADD
Show:
© 2014 Microsoft