In This Topic ▼

IltmmTargetFormat::put_UseFilterCache

Summary

Enables or disables the caching of filters.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmTargetFormat_put_UseFilterCache(pTargetFormat, newVal)
C++	HRESULT put_UseFilterCache(newVal)

Parameters

IltmmTargetFormat *pTargetFormat

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

VARIANT_BOOL newVal

Flag that indicates whether to enable or disable the caching of filters. Possible values are:

Value	Meaning
VARIANT_TRUE	Enable the caching of filters.
VARIANT_FALSE	Disable the caching of filters. This is the default value.

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 function will force the toolkit to preload and reuse the filters specified for the particular format. Calling the IltmmTargetFormat::put_UserFilterCache function with VARIANT_TRUE will enable caching for this target format. If there is not a currently created object, then it will create it. Setting this function to VARIANT_FALSE will disable the caching for this target object. If an object is already created, it will destroy it.

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

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