Expand Minimize

KsFreeObjectBag function

The KsFreeObjectBag function empties and frees an object bag.

Syntax


void KsFreeObjectBag(
  _In_  KSOBJECT_BAG ObjectBag
);

Parameters

ObjectBag [in]

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

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

Library

Ks.lib

IRQL

PASSIVE_LEVEL

See also

KsAllocateObjectBag
KsAddItemToObjectBag
KsRemoveItemFromObjectBag
KsDiscard
KsCopyObjectBagItems

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.