Функция KsAllocateObjectBag (ks.h)

Функция KsAllocateObjectBag создает контейнер объектов и связывает его с KSDEVICE.

Синтаксис

KSDDKAPI NTSTATUS KsAllocateObjectBag(
  [in]  PKSDEVICE    Device,
  [out] KSOBJECT_BAG *ObjectBag
);

Параметры

[in] Device

Указатель на KSDEVICE, представляющий объект устройства, связанный с вновь созданным контейнером объектов.

[out] ObjectBag

Указатель на KSOBJECT_BAG (структура KSOBJECT_BAG эквивалентна типу PVOID), где помещается только что выделенный контейнер объектов.

Возвращаемое значение

Возвращает STATUS_SUCCESS, если создан новый контейнер объектов. Если новый контейнер объектов не выделен, он возвращает STATUS_INSUFFICIENT_RESOURCES.

Комментарии

Выделенный контейнер объектов не удаляется автоматически. Мини-диск, вызывающий KsAllocateObjectBag , отвечает за удаление контейнера объектов. Самый простой способ сделать это — вызвать KsFreeObjectBag. Кроме того, если мини-диск содержит адреса элементов в сумке, мини-диск может удалить их по отдельности, вызвав KsRemoveItemFromObjectBag.

Дополнительные сведения см. в разделе Контейнеры объектов.

Требования

Требование Значение
Минимальная версия клиента Доступно в операционных системах Microsoft Windows XP и более поздних версиях, а также DirectX 8.0 и более поздних версиях.
Целевая платформа Универсальное
Верхняя часть ks.h (включая Ks.h)
Библиотека Ks.lib
IRQL PASSIVE_LEVEL

См. также раздел

KsAddItemToObjectBag

KsCopyObjectBagItems

KsDiscard

KsFreeObjectBag

KsRemoveItemFromObjectBag