KsDiscard macro (ks.h)

Article
02/22/2024

The KsDiscard macro removes a given item from an object bag.

Syntax

void KsDiscard(
  [in]  Object,
  [in]  Pointer
);

Parameters

[in] Object

The item pointed to by Pointer is removed from the object bag associated with this object. Can be of type KSDEVICE, KSFILTERFACTORY, KSFILTER, or KSPIN.

[in] Pointer

A pointer to the item to be removed from the requested object's bag.

Return value

None

Remarks

This macro wraps and assumes the return value of KsRemoveItemFromObjectBag, which is ULONG.

This function is implemented as a C-style preprocessing macro in the Ks.h header.

KsDiscard calls KsRemoveItemFromObjectBag, passing the object bag associated with Object (Object->Bag), the item specified by Pointer, and TRUE for the Free parameter.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform	Desktop
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	PASSIVE_LEVEL