IltmmMediaTypeDisp::get_Format

#include "ltmm.h"

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

IltmmMediaTypeDisp *pMediaTypeDisp;	pointer to an interface
VARIANT *pVal;	pointer to a VARIANT

Gets a direct reference to the format buffer.

Parameter	Description
pMediaTypeDisp	Pointer to an IltmmMediaTypeDisp interface.
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

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.

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_FormatSize, IltmmMediaTypeDisp::get_FormatType, IltmmMediaTypeDisp::get_SampleSize, IltmmMediaTypeDisp::get_Subtype, IltmmMediaTypeDisp::get_TemporalCompression, IltmmMediaTypeDisp::get_Type, IltmmMediaTypeDisp::GetFormatData, 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