15.03.2015 Views

SetupDesignGuide.pdf - Firmware Encoding Index

SetupDesignGuide.pdf - Firmware Encoding Index

SetupDesignGuide.pdf - Firmware Encoding Index

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Setup Design Guide<br />

DRAFT<br />

7.1.12 EFI_HII_PROTOCOL.UpdateForm()<br />

Summary<br />

This function allows the caller to update a form or form package that has previously been registered<br />

with the EFI HII database.<br />

Prototype<br />

EFI_STATUS<br />

(EFIAPI *EFI_HII_UPDATE_FORM) {<br />

IN EFI_HII_PROTOCOL *This,<br />

IN EFI_HII_HANDLE Handle,<br />

IN EFI_FORM_LABEL Label,<br />

IN UINT16<br />

BufferLength,<br />

IN UINT8<br />

*Buffer<br />

};<br />

Parameters<br />

This<br />

Handle<br />

Label<br />

BufferLength<br />

Buffer<br />

A pointer to the EFI_HII_PROTOCOL instance.<br />

Handle of the package where the form to be updated resides.<br />

The label inside the form package where the update is to take place.<br />

The length of the Buffer.<br />

The buffer containing the new tags to insert before Label.<br />

Description<br />

This function allows a program to update a form at runtime. The form must have been built expecting<br />

the update, as a labÄel tag is required. The tags in Buffer are inserted into the form just prior to the<br />

label tag.<br />

Status Codes Returned<br />

EFI_SUCCESS<br />

EFI_INVALID_PARAMETER<br />

EFI_NOT_FOUND<br />

The Form was updated with the new tags.<br />

The buffer for the buffer length does not contain an integral<br />

number of tags.<br />

The Handle, Label, or FormId was not found.<br />

65

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!