iPXE
Data Structures | Defines | Typedefs | Functions | Variables
ComponentName.h File Reference

EFI Component Name Protocol as defined in the EFI 1.1 specification. More...

Go to the source code of this file.

Data Structures

struct  _EFI_COMPONENT_NAME_PROTOCOL
 This protocol is used to retrieve user readable names of drivers and controllers managed by UEFI Drivers. More...

Defines

#define EFI_COMPONENT_NAME_PROTOCOL_GUID
 The global ID for the Component Name Protocol.

Typedefs

typedef struct
_EFI_COMPONENT_NAME_PROTOCOL 
EFI_COMPONENT_NAME_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_COMPONENT_NAME_GET_DRIVER_NAME )(IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
 Retrieves a Unicode string that is the user-readable name of the EFI Driver.
typedef EFI_STATUS(EFIAPIEFI_COMPONENT_NAME_GET_CONTROLLER_NAME )(IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT CHAR16 **ControllerName)
 Retrieves a Unicode string that is the user readable name of the controller that is being managed by an EFI Driver.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiComponentNameProtocolGuid

Detailed Description

EFI Component Name Protocol as defined in the EFI 1.1 specification.

This protocol is used to retrieve user readable names of EFI Drivers and controllers managed by EFI Drivers.

Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file ComponentName.h.


Define Documentation

Value:
{ \
    0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

The global ID for the Component Name Protocol.

Definition at line 25 of file ComponentName.h.


Typedef Documentation

Definition at line 30 of file ComponentName.h.

Retrieves a Unicode string that is the user-readable name of the EFI Driver.

Parameters:
ThisA pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
LanguageA pointer to a three-character ISO 639-2 language identifier. This is the language of the driver name that that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer.
DriverNameA pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language specified by Language.
Return values:
EFI_SUCCESSThe Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETERLanguage is NULL.
EFI_INVALID_PARAMETERDriverName is NULL.
EFI_UNSUPPORTEDThe driver specified by This does not support the language specified by Language.

Definition at line 57 of file ComponentName.h.

Retrieves a Unicode string that is the user readable name of the controller that is being managed by an EFI Driver.

Parameters:
ThisA pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandleThe handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned.
ChildHandleThe handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a child controller.
LanguageA pointer to a three character ISO 639-2 language identifier. This is the language of the controller name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer.
ControllerNameA pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language, from the point of view of the driver specified by This.
Return values:
EFI_SUCCESSThe Unicode string for the user-readable name in the language specified by Language for the driver specified by This was returned in DriverName.
EFI_INVALID_PARAMETERControllerHandle is NULL.
EFI_INVALID_PARAMETERChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETERLanguage is NULL.
EFI_INVALID_PARAMETERControllerName is NULL.
EFI_UNSUPPORTEDThe driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTEDThe driver specified by This does not support the language specified by Language.

Definition at line 106 of file ComponentName.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation