KsRemoveItemFromObjectBag function (ks.h)

Article
03/15/2022

The KsRemoveItemFromObjectBag function removes an item from an object bag.

Syntax

KSDDKAPI ULONG KsRemoveItemFromObjectBag(
  [in] KSOBJECT_BAG ObjectBag,
  [in] PVOID        Item,
  [in] BOOLEAN      Free
);

Parameters

[in] ObjectBag

This parameter specifies the KSOBJECT_BAG (equivalent to type PVOID) from which to remove Item.

[in] Item

A pointer to the item to remove from the requested object bag. Note that Item is removed from the requested object bag only. It is not removed from any other object bags that it may be in.

[in] Free

This parameter specifies whether Item should be freed once it has been removed from the specified object bag. Only set Free to TRUE if Item is not contained in any other object bag.

Return value

Returns the number of references on Item. A return value of zero indicates that Item was not in ObjectBag at call-time.

A return value of one indicates that Item was successfully removed from ObjectBag and that it was not in any other object bag. If a free was requested in this case, AVStream frees Item using either ExFreePool or the Free method specified at KsAddItemToObjectBag call-time.

A return value above one indicates that the item is present in another object bag and that there are still references on it. In this case, AVStream removed Item from ObjectBag, but did not free it regardless of the value of Free.

Remarks

KsRemoveItemFromObjectBag frees Item only if the number of references on this item is zero and a free was requested.

For more information about object bags, see Object Bags.

Note that the mutex associated with the bag must be held. For more information, see Mutexes in AVStream.

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