Efi_component_name_protocol.getdrivername(), Getdrivername(), Func – Intel Extensible Firmware Interface User Manual

Page 290

Advertising
background image

Extensible Firmware Interface Specification

9-48

12/01/02

Version 1.10

EFI_COMPONENT_NAME_PROTOCOL.GetDriverName()

Summary

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME) (
IN EFI_COMPONENT_NAME_PROTOCOL

*This,

IN CHAR8

*Language,

OUT CHAR16

**DriverName

);

Parameters

This

A pointer to the

EFI_COMPONENT_NAME_PROTOCOL

instance.

Language

A 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.

DriverName

A 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

.

Description

This function retrieves the user readable name of an EFI Driver in the form of a Unicode string. If
the driver specified by

This

has a user readable name in the language specified by

Language

,

then a pointer to the driver name is returned in

DriverName

, and

EFI_SUCCESS

is returned. If

the driver specified by

This

does not support the language specified by

Language

, then

EFI_UNSUPPORTED

is returned.

Advertising