Iterator APIs

Typedefs
typedef EFI_STATUS(EFIAPI *	EDKII_AML_TREE_ITERATOR_GET_NODE) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *OutNode)
typedef EFI_STATUS(EFIAPI *	EDKII_AML_TREE_ITERATOR_GET_NEXT) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *NextNode)
typedef EFI_STATUS(EFIAPI *	EDKII_AML_TREE_ITERATOR_GET_PREVIOUS) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *PrevNode)

Functions
EFI_STATUS EFIAPI	AmlInitializeIterator (IN AML_NODE_HANDLE Node, IN EAML_ITERATOR_MODE IteratorMode, OUT AML_TREE_ITERATOR **IteratorPtr)
EFI_STATUS EFIAPI	AmlDeleteIterator (IN AML_TREE_ITERATOR *Iterator)

Detailed Description

Iterator APIs defines the action that can be done on an iterator:

• Initialization;
• Deletion;
• Getting the node currently pointed by the iterator;
• Moving to the next node;
• Moving to the previous node.

Typedef Documentation

EDKII_AML_TREE_ITERATOR_GET_NEXT

typedef EFI_STATUS(EFIAPI * EDKII_AML_TREE_ITERATOR_GET_NEXT) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *NextNode)

Function pointer to move the current node of the iterator to the next node, according to the iteration mode selected.

If NextNode is not NULL, return the next node.

Parameters

[in]	Iterator	Pointer to an iterator.
[out]	NextNode	If not NULL, updated to the next node.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 137 of file AmlTreeIterator.h.

EDKII_AML_TREE_ITERATOR_GET_NODE

typedef EFI_STATUS(EFIAPI * EDKII_AML_TREE_ITERATOR_GET_NODE) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *OutNode)

Function pointer to a get the current node of the iterator.

Parameters

[in]	Iterator	Pointer to an iterator.
[out]	OutNode	Pointer holding the current node.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 117 of file AmlTreeIterator.h.

EDKII_AML_TREE_ITERATOR_GET_PREVIOUS

typedef EFI_STATUS(EFIAPI * EDKII_AML_TREE_ITERATOR_GET_PREVIOUS) (IN AML_TREE_ITERATOR *Iterator, OUT AML_NODE_HANDLE *PrevNode)

Function pointer to move the current node of the iterator to the previous node, according to the iteration mode selected.

If PrevNode is not NULL, return the previous node.

Parameters

[in]	Iterator	Pointer to an iterator.
[out]	PrevNode	If not NULL, updated to the previous node.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 157 of file AmlTreeIterator.h.

Function Documentation

AmlDeleteIterator()

EFI_STATUS EFIAPI AmlDeleteIterator

(

IN AML_TREE_ITERATOR *

Iterator

)

Delete an iterator.

Note: The caller must have first initialized the iterator with the AmlInitializeIterator () function.

Parameters

[in]

Iterator

Pointer to an iterator.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 353 of file AmlTreeIterator.c.

AmlInitializeIterator()

EFI_STATUS EFIAPI AmlInitializeIterator	(	IN AML_NODE_HANDLE	Node,
		IN EAML_ITERATOR_MODE	IteratorMode,
		OUT AML_TREE_ITERATOR **	IteratorPtr
	)

Initialize an iterator.

Note: The caller must call AmlDeleteIterator () to free the memory allocated for the iterator.

Parameters

[in]	Node	Pointer to the node.
[in]	IteratorMode	Selected mode to traverse the tree.
[out]	IteratorPtr	Pointer holding the created iterator.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.
EFI_OUT_OF_RESOURCES	Could not allocate memory.