In This Topic ▼

IltmmTargetFormat::GetCacheObjectDispatch

Summary

Retrieves the caching filter object's IDispatch interface.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmTargetFormat_GetCacheObjectDispatch(pTargetFormat, ObjType, ppObject)
C++	HRESULT GetCacheObjectDispatch(ObjType, ppObject)

Parameters

IltmmTargetFormat *pTargetFormat

Pointer to an IltmmTargetFormat interface

long ObjType

Value that indicates which caching object to retrieve. This must be one of the ltmmTargetFormat_Object constants.

IDispatch **ppObject

Pointer to a variable to receive the caching filter object IDispatch interface pointer.

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 method allows you to retrieve an interface for a cached object. It is similar to IltmmTargetFormat::GetCacheObject, except that this method retrieves an IDispatch interface.

Some programming languages (VB, Delphi) work only with IDispatch. For these interfaces, you should call IltmmTargetFormat::GetCacheObjectDispatch. For the other languages, you can call this method or IltmmTargetFormat::GetCacheObject.

C/C++ programmers can use IUnknown interfaces, so they can use IltmmTargetFormat::GetCacheObject instead.

Use the IltmmTargetFormat::get_UseFilterCache function to query whether the toolkit is caching filters.

Use the IltmmTargetFormat::put_UseFilterCache function to enable or disable caching for the target format.

Use the IltmmTargetFormat::GetCacheObject function to retrieve the caching filter object.

Use the IltmmTargetFormat::ShowCacheDialog function to display a specific property dialog for the caching filter.

Use the IltmmTargetFormat::HasCacheDialog function to query whether the specified property dialog for the caching filter is available.

The user is responsible for releasing the retrieved caching filter object by calling its Release() function when it is no longer needed.

To see how you would use IltmmTargetFormat::GetCacheObjectDisp, look at the IltmmTargetFormat::GetCacheObject examples and just replace IUnknown with IDispatch.

Required DLLs and Libraries

LTMM
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Example

NOTE: Only replace IUnknown with IDispatch in the following examples.

Language	Example
C	• IltmmTargetFormat::CreateTargetFormats
	• IltmmTargetFormat::put_UseFilterCache
C++	• IltmmTargetFormat::CreateTargetFormats
	• IltmmTargetFormat::put_UseFilterCache