KsCopyObjectBagItems function (ks.h)

Article
02/22/2024

The KsCopyObjectBagItems function copies all items from one object bag into another.

Syntax

KSDDKAPI NTSTATUS KsCopyObjectBagItems(
  [in] KSOBJECT_BAG ObjectBagDestination,
  [in] KSOBJECT_BAG ObjectBagSource
);

Parameters

[in] ObjectBagDestination

The KSOBJECT_BAG (equivalent to type PVOID) into which to copy items.

[in] ObjectBagSource

The KSOBJECT_BAG from which items are copied to ObjectBagDestination.

Return value

Returns STATUS_SUCCESS if the copy is successful. Otherwise, it returns an error code. Most often, this is STATUS_INSUFFICIENT_RESOURCES indicating insufficient system resources to complete the copy operation. If STATUS_INSUFFICIENT_RESOURCES is returned, it is quite possible that some, but not all, of the items have been copied from ObjectBagSource to ObjectBagDestination.

Remarks

Note that mutexes for both bags should be held. If the object bag in question is associated with a filter or a pin, acquire the filter control mutex. If the object bag belongs to a filter factory or the device, acquire the device mutex. For more information, see Object Bags and 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