Collapse All Expand All

IltmmMediaTypeDisp::GetPortableType

#include "ltmm.h"

C Syntax	HRESULT IltmmMediaTypeDisp_getPortableType(pMediaTypeDisp, Type)
C++ Syntax	HRESULT GetPortableType(Type)

 

IltmmMediaTypeDisp *pMediaTypeDisp;	/* pointer to an interface */
VARIANT *Type;	/* pointer to a VARIANT */

Retrieves a portable version of the media type.

Parameter	Description
pMediaTypeDisp	Pointer to an IltmmMediaTypeDisp interface.
Type	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 portable media type information.

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 function allows the user to retrieve the media type in a flat format that can be transported across networks.

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

The portable type contains all the data needed to fully reconstruct the media type.

For more information on using the high level method of acquiring the media type, refer to IltmmMediaTypeDisp interface.

Platforms

Win32, x64

See Also

Elements:	IltmmMediaTypeDisp::SetPortableType
Topics:	Multimedia Function Group
	IltmmMediaTypeDisp interface
	ltmmMediaType object

Example

For a C example, refer to Capture to Play Object Interfacing for C.

For a C++ example, refer to Capture to Play Object Interfacing for C++.