4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI Component Name Protocol as defined in the EFI 1.1 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol is used to retrieve user readable names of EFI Drivers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and controllers managed by EFI Drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The global ID for the Component Name Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a Unicode string that is the user-readable name of the EFI Driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language A pointer to a three-character ISO 639-2 language identifier.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the language of the driver name that that the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is requesting, and it must match one of the languages specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in SupportedLanguages. The number of languages supported by a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver is up to the driver writer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverName A pointer to the Unicode string to return. This Unicode string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is the name of the driver specified by This in the language
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Language.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Unicode string for the Driver specified by This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the language specified by Language was returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in DriverName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Language is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DriverName is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The driver specified by This does not support the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync language specified by Language.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a Unicode string that is the user readable name of the controller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that is being managed by an EFI Driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerHandle The handle of a controller that the driver specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is managing. This handle specifies the controller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync whose name is to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ChildHandle The handle of the child controller to retrieve the name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of. This is an optional parameter that may be NULL. It
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be NULL for device drivers. It will also be NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a bus drivers that wish to retrieve the name of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bus controller. It will not be NULL for a bus driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that wishes to retrieve the name of a child controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language A pointer to a three character ISO 639-2 language
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync identifier. This is the language of the controller name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that the caller is requesting, and it must match one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the languages specified in SupportedLanguages. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of languages supported by a driver is up to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver writer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerName A pointer to the Unicode string to return. This Unicode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string is the name of the controller specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle and ChildHandle in the language specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by Language, from the point of view of the driver specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Unicode string for the user-readable name in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync language specified by Language for the driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by This was returned in DriverName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Language is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ControllerName is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The driver specified by This is not currently managing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the controller specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ChildHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The driver specified by This does not support the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync language specified by Language.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol is used to retrieve user readable names of drivers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and controllers managed by UEFI Drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A Null-terminated ASCII string that contains one or more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ISO 639-2 language codes. This is the list of language codes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that this protocol supports.