IltmmMediaTypeDisp::get_Format

Summary

Gets a direct reference to the format buffer.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmMediaTypeDisp_get_Format(pMediaTypeDisp, pVal)
C++	HRESULT get_Format(pVal)

Parameters

IltmmMediaTypeDisp *pMediaTypeDisp

Pointer to an IltmmMediaTypeDisp interface.

VARIANT *pVal

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 contains the format information based on the format type.

Returns

Value	Meaning
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

This routine will allow direct access to the format buffer for in-process servers. However, if the interface is marshaled across process boundaries, then the client will only be accessing a copy of the data. In such a case, the client should call IltmmMediaTypeDisp::SetFormatData to alter the contents of the format buffer.

The array referenced by pVal cannot be resized. To resize the format buffer, call IltmmMediaTypeDisp::put_FormatSize and then call IltmmMediaTypeDisp::get_Format again.

Language	Example
C	Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget
C++	Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget

IltmmMediaTypeDisp::get_Format

Summary

Syntax

Parameters

IltmmMediaTypeDisp *pMediaTypeDisp

VARIANT *pVal

Returns

Comments

Platforms

See Also

Functions

Topics

Example