Enumeration APIs are navigation APIs, allowing to call a callback function on each node enumerated. Nodes are enumerated in the AML bytestream order, i.e. in a depth first order.
◆ EDKII_AML_TREE_ENUM_CALLBACK
Callback function prototype used when iterating through the tree.
- Parameters
-
| [in] | Node | The Node currently being processed. |
| [in,out] | Context | A context for the callback function. Can be optional. |
| [in,out] | Status | End the enumeration if pointing to a value evaluated to TRUE. Can be optional. |
- Return values
-
| TRUE | if the enumeration can continue or has finished without interruption. |
| FALSE | if the enumeration needs to stopped or has stopped. |
Definition at line 684 of file AmlCoreInterface.h.
◆ AmlEnumTree()
Enumerate all nodes of the subtree under the input Node in the AML bytestream order (i.e. in a depth first order), and call the CallBack function with the input Context. The prototype of the Callback function is EDKII_AML_TREE_ENUM_CALLBACK.
- Parameters
-
| [in] | Node | Enumerate nodes of the subtree under this Node. Must be a valid node. |
| [in] | CallBack | Callback function to call on each node. |
| [in,out] | Context | Void pointer used to pass some information to the Callback function. Optional, can be NULL. |
| [out] | Status | Optional parameter that can be used to get the status of the Callback function. If used, need to be init to EFI_SUCCESS. |
- Return values
-
| TRUE | if the enumeration can continue or has finished without interruption. |
| FALSE | if the enumeration needs to stopped or has stopped. |
1.9.6