Edit

WdfCollectionRemoveItem function (wdfcollection.h)

  • Article

[Applies to KMDF and UMDF]

The WdfCollectionRemoveItem method removes a specified object from an object collection, based on a specified index value.

Syntax

void WdfCollectionRemoveItem(
  [in] WDFCOLLECTION Collection,
  [in] ULONG         Index
);

Parameters

[in] Collection

A handle to a collection object.

[in] Index

A zero-based index that identifies the object to remove.

Return value

None

Remarks

A bug check occurs if the driver supplies an invalid object handle.

Index values represent the order in which objects are added to a collection. An index value of zero represents the first object that was added to the collection, an index value of one represents the second object, and so on.

When WdfCollectionRemoveItem removes an object from a collection, it decrements the object's reference count.

For more information about object collections, see Framework Object Collections

Examples

For a code example that uses WdfCollectionRemoveItem, see WdfCollectionGetFirstItem.

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfcollection.h (include Wdf.h)
Library Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
DDI compliance rules DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

See also

WdfCollectionRemove