Efi_driver_configuration_protocol.setoptions(), Setoptions(), Func – Intel Extensible Firmware Interface User Manual

Page 277

Advertising
background image

Protocols

— EFI Driver Model

Version 1.10

12/01/02

9-35

EFI_DRIVER_CONFIGURATION_PROTOCOL.SetOptions()

Summary

Allows the user to set controller specific options for a controller that a driver is currently managing.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS) (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL

*This,

IN EFI_HANDLE

ControllerHandle,

IN EFI_HANDLE

ChildHandle OPTIONAL,

IN CHAR8

*Language,

OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED

*ActionRequired

);

Parameters

This

A pointer to the

EFI_DRIVER_CONFIGURATION_

PROTOCOL

instance.

ControllerHandle

The handle of the controller to set options on. If

ControllerHandle

is a valid

EFI_HANDLE

that is being

managed by this driver, then the user will be allowed to set
options for the controller specified by

ControllerHandle

.

If this parameter is

NULL

, then the options will be set for all the

controllers that this driver is currently managing. If

ControllerHandle

is

NULL

, then setting options for a child

controller is not supported, so

ChildHandle

must also be

NULL

.

ChildHandle

The handle of the child controller to set options on. This is an
optional parameter that may be

NULL

. It will be

NULL

for

device drivers, and for a bus drivers that wish to set options for
the bus controller. It will not be

NULL

for a bus driver that

wishes to set options for one of its child controllers.

Language

A pointer to a three character ISO 639-2 language identifier.
This is the language of the user interface that should be
presented to the user, 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.

ActionRequired

A pointer to the action that the calling agent is required to
perform when this function returns. See "Related Definitions"
for a list of the actions that the calling agent is required to
perform prior to accessing

ControllerHandle

again.

Advertising