ConfigurationManagerHelper.h File Reference

Macros
#define	GET_OBJECT_LIST(CmObjectNameSpace, CmObjectId, Type)

Detailed Description

Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Glossary:

• Cm or CM - Configuration Manager
• Obj or OBJ - Object

Macro Definition Documentation

#define GET_OBJECT_LIST	(		CmObjectNameSpace,
			CmObjectId,
			Type
	)

The GET_OBJECT_LIST macro expands to a function that is used to retrieve an object or an object list from the Configuration Manager using the Configuration Manager Protocol interface.

The macro expands to a function which has the following prototype:

STATIC EFI_STATUS EFIAPI Get<CmObjectId> ( IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol, IN CONST CM_OBJECT_TOKEN Token OPTIONAL, OUT Type ** List, OUT UINT32 * Count OPTIONAL );

Generated function parameters:

Parameters

[in]	CfgMgrProtocol	Pointer to the Configuration Manager protocol interface.
[in]	Token	Reference token for the Object.
[out]	List	Pointer to the Object list.
[out]	Count	Count of the objects returned in the list.

Macro Parameters:

Parameters

[in]	CmObjectNameSpace	The Object Namespace
[in]	CmObjectId	Object Id.
[in]	Type	Structure used to describe the Object.

Return values

EFI_SUCCESS	Success.
EFI_INVALID_PARAMETER	A parameter is invalid.
EFI_NOT_FOUND	The required object information is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size for the requested object.