IltmmMediaTypeDisp::GetFormatData

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaTypeDisp_getFormatData(pMediaTypeDisp, DataSize, Data)

C++ Syntax

HRESULT GetFormatData(DataSize, Data)

 

IltmmMediaTypeDisp *pMediaTypeDisp;

/* pointer to an interface */

long DataSize;

/* size of the format data */

VARIANT *Data;

/* pointer to a VARIANT */

Retrieves a copy of the format buffer.

Parameter

Description

pMediaTypeDisp

Pointer to an IltmmMediaTypeDisp interface.

DataSize

Length of the data to retrieve, in bytes.

Data

Pointer to a variable to be updated with a VARIANT containing a SAFEARRAY reference. The array is composed of a single dimension of bytes. This array will be updated with the actual format data.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

If the function succeeds, the caller must free the VARIANT referenced by pVal by calling the VariantClear function.

Platforms

Win32, x64

See Also

Elements:

IltmmMediaTypeDisp::get_FixedSizeSamples, IltmmMediaTypeDisp::get_Format, IltmmMediaTypeDisp::get_FormatSize, IltmmMediaTypeDisp::get_FormatType, IltmmMediaTypeDisp::get_SampleSize, IltmmMediaTypeDisp::get_Subtype, IltmmMediaTypeDisp::get_TemporalCompression, IltmmMediaTypeDisp::get_Type, IltmmMediaTypeDisp::put_FixedSizeSamples, IltmmMediaTypeDisp::put_FormatSize, IltmmMediaTypeDisp::put_FormatType, IltmmMediaTypeDisp::put_SampleSize, IltmmMediaTypeDisp::put_Subtype, IltmmMediaTypeDisp::put_TemporalCompression, IltmmMediaTypeDisp::put_Type, IltmmMediaTypeDisp::SetFormatData

Topics:

Multimedia Function Group

 

IltmmMediaTypeDisp interface

 

ltmmMediaType object

Example

For a C example, refer to Copying ltmmMediaType Attributes and Data for C.

For a C++ example, refer to Copying ltmmMediaType Attributes and Data for C++.