In This Topic ▼

IltmmTargetFormat::GetCacheObject

Summary

Retrieves the caching filter object.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmTargetFormat_getCacheObject(pTargetFormat, ObjType, ppObject)
C++	HRESULT GetCacheObject(ObjType, ppObject)

Parameters

IltmmTargetFormat *pTargetFormat

Pointer to the IltmmTargetFormat interface that references the target format object.

long ObjType

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

IUnknown **ppObject

Pointer to a variable to receive the caching filter object 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

Use the IltmmTargetFormat::get_UseFilterCache function to query whether the toolkit is caching filters. It returns the value that was set using the IltmmTargetFormat::put_UserFilterCache. 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.

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

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