WdfFdoLockStaticChildListForIteration function (wdffdo.h)

[Applies to KMDF only]

The WdfFdoLockStaticChildListForIteration method prepares the framework for retrieving items from the static child list that belongs to a specified parent device.

Syntax

void WdfFdoLockStaticChildListForIteration(
  [in] WDFDEVICE Fdo
);

Parameters

[in] Fdo

A handle to a framework device object that represents the parent device.

Return value

None

Remarks

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

Bus drivers that use static bus enumeration can call WdfFdoLockStaticChildListForIteration.

After calling WdfFdoLockStaticChildListForIteration, the driver can repeatedly call WdfFdoRetrieveNextStaticChild to obtain information about each child device in the child list.

After the driver has finished calling WdfFdoRetrieveNextStaticChild, it must call WdfFdoUnlockStaticChildListFromIteration.

If the driver makes changes to the child list after calling WdfFdoLockStaticChildListForIteration, the framework stores all of the changes and notifies the Plug and Play (PnP) manager of the changes when the driver calls WdfFdoUnlockStaticChildListFromIteration.

The driver can nest calls to WdfFdoLockStaticChildListForIteration and WdfFdoUnlockStaticChildListFromIteration. If the driver nests calls to these methods, the framework stores all of the changes until the last call to WdfFdoUnlockStaticChildListFromIteration.

For more information about static child lists, see Static Enumeration.

Examples

For a code example that uses WdfFdoLockStaticChildListForIteration, see WdfFdoRetrieveNextStaticChild.

Requirements

See also

WdfFdoUnlockStaticChildListFromIteration