BdaFilterFactoryUpdateCacheData function (bdasup.h)

Article
06/29/2022

The BdaFilterFactoryUpdateCacheData function updates the pin data cache for an instance of a filter.

Syntax

NTSTATUS BdaFilterFactoryUpdateCacheData(
  [in]           PKSFILTERFACTORY          pFilterFactory,
  [in, optional] const KSFILTER_DESCRIPTOR *pFilterDescriptor
);

Parameters

[in] pFilterFactory

Points to the KSFILTERFACTORY for which to update the pin data cache.

[in, optional] pFilterDescriptor

Points to an optional KSFILTER_DESCRIPTOR for which the pin data cache will be updated. If NULL, pFilterFactory's descriptor is used instead. This parameter enables dynamic pin creation, that is, pin creation that occurs after a filter's create dispatch routine completes.

Return value

Returns STATUS_SUCCESS or an appropriate error code. Returns STATUS_INVALID_PARAMETER if no device interface is found that corresponds to the categories passed in the filter descriptor.

Remarks

A BDA minidriver calls the BdaFilterFactoryUpdateCacheData function to update the pin data cache for all pins specified at pFilterDescriptor. In this call, the BDA minidriver typically passes the pFilterDescriptor member of a BDA_FILTER_TEMPLATE structure that describes the template topology for the BDA filter to pFilterDescriptor. If pFilterDescriptor is NULL, the cached information will be updated for all pin factories specified at pFilterFactory's KSFILTER_DESCRIPTOR member. For information about the pin data cache, see Caching Pin Information for DirectShow.

The KsRegisterFilterWithNoKSPins function provides similar functionality but only allows one medium per registered pin. This may not be sufficient for a BDA minidriver.

Requirements

Requirement	Value
Target Platform	Desktop
Header	bdasup.h (include Bdasup.h)
Library	Bdasup.lib
IRQL	PASSIVE_LEVEL