WdfCollectionRemoveItem method

WdfCollectionRemoveItem method

[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

Collection [in]

A handle to a collection object.

Index [in]

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

Return value

None.

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

Remarks

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

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, KmdfIrql, KmdfIrql2

See also

WdfCollectionRemove

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft