KsFreeObjectBag function (ks.h)

Article
02/22/2024

The KsFreeObjectBag function empties and frees an object bag.

Syntax

void KsFreeObjectBag(
  [in] KSOBJECT_BAG ObjectBag
);

Parameters

[in] ObjectBag

The KSOBJECT_BAG (equivalent to type PVOID) to be emptied and then freed.

Return value

None

Remarks

For more information, see Object Bags.

KsFreeObjectBag removes any items present in ObjectBag. In addition, if the reference count for a given object is zero (that is, the object is not present in any other object bag associated with the same device as ObjectBag), then that item is freed.

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	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	PASSIVE_LEVEL