Fungsi KsRemoveItemFromObjectBag (ks.h)

Artikel
02/26/2024

Fungsi KsRemoveItemFromObjectBag menghapus item dari tas objek.

Sintaks

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

Parameter

[in] ObjectBag

Parameter ini menentukan KSOBJECT_BAG (setara dengan jenis PVOID) untuk menghapus Item.

[in] Item

Penunjuk ke item untuk dihapus dari tas objek yang diminta. Perhatikan bahwa Item hanya dihapus dari tas objek yang diminta. Ini tidak dihapus dari tas objek lain yang mungkin ada di dalamnya.

[in] Free

Parameter ini menentukan apakah Item harus dibebaskan setelah dihapus dari tas objek yang ditentukan. Hanya atur Gratis ke TRUE jika Item tidak terkandung dalam tas objek lainnya.

Nilai kembali

Mengembalikan jumlah referensi pada Item. Nilai pengembalian nol menunjukkan bahwa Item tidak berada di ObjectBag pada waktu panggilan.

Nilai pengembalian dari salah satu menunjukkan bahwa Item berhasil dihapus dari ObjectBag dan tidak ada di tas objek lainnya. Jika gratis diminta dalam hal ini, AVStream membebaskan Item menggunakan ExFreePool atau metode Gratis yang ditentukan di waktu panggilan KsAddItemToObjectBag .

Nilai pengembalian di atas satu menunjukkan bahwa item ada di tas objek lain dan masih ada referensi di dalamnya. Dalam hal ini, AVStream menghapus Item dari ObjectBag, tetapi tidak membebaskannya terlepas dari nilai Gratis.

Keterangan

KsRemoveItemFromObjectBag membebaskan Item hanya jika jumlah referensi pada item ini adalah nol dan gratis diminta.

Untuk informasi selengkapnya tentang tas objek, lihat Tas Objek.

Perhatikan bahwa mutex yang terkait dengan tas harus ditahan. Untuk informasi selengkapnya, lihat Mutex di AVStream.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Microsoft Windows XP dan sistem operasi yang lebih baru dan DirectX 8.0 dan versi DirectX yang lebih baru.
Target Platform	Universal
Header	ks.h (termasuk Ks.h)
Pustaka	Ks.lib
IRQL	PASSIVE_LEVEL