UID

title

description

old-location

tech.root

ms.date

keywords

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

f1_keywords

topic_type

api_type

api_location

api_name

NF:ks.KsCopyObjectBagItems

KsCopyObjectBagItems function (ks.h)

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

stream\kscopyobjectbagitems.htm

stream

04/23/2018

KsCopyObjectBagItems function

KsCopyObjectBagItems, KsCopyObjectBagItems function [Streaming Media Devices], avfunc_26fe6218-6e9e-4a1a-93c6-f8f2ca10abbb.xml, ks/KsCopyObjectBagItems, stream.kscopyobjectbagitems

ks.h

Ks.h

Universal

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

Ks.lib

PASSIVE_LEVEL

Windows

KsCopyObjectBagItems

ks/KsCopyObjectBagItems

APIRef

kbSyntax

LibDef

Ks.lib

Ks.dll

KsCopyObjectBagItems

KsCopyObjectBagItems function

-description

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

-parameters

-param ObjectBagDestination [in]

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

-param ObjectBagSource [in]

The KSOBJECT_BAG from which items are copied to ObjectBagDestination.

-returns

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.