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.6 EFI_HII_PROTOCOL.NewString()<br />

Summary<br />

This function allows a new String to be added to an already existing String Package.<br />

Prototype<br />

EFI_STATUS<br />

(EFIAPI *EFI_HII_NEW_STRING) (<br />

IN EFI_HII_PROTOCOL *This,<br />

IN CHAR16<br />

*Language,<br />

IN EFI_HII_HANDLE Handle,<br />

IN STRING_REF<br />

*Reference,<br />

IN CHAR16<br />

*NewString<br />

);<br />

Parameters<br />

This<br />

Language<br />

Handle<br />

A pointer to the EFI_HII_PROTOCOL instance.<br />

Pointer to a NULL-terminated string containing a single ISO-639-2<br />

language identifier, indicating the language the string is translated<br />

in. A string consisting of all spaces indicates that the string is<br />

applicable to all languages.<br />

The handle of the language pack to which the string is to be added.<br />

Reference The identifier of the string to be added. If the reference value is 0,<br />

then the string will be assigned a new identifier on that handle for<br />

the Language specified. Otherwise, the string will be updated with<br />

the NewString Value.<br />

NewString<br />

Description<br />

The string to be added.<br />

This routine adds a new string to a string package already submitted via NewPack. This string<br />

effectively overwrites existing strings.<br />

Status Codes Returned<br />

EFI_SUCCESS<br />

EFI_INVALID_PARAMETER<br />

String effectively registered.<br />

Unknown handle.<br />

57

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

Saved successfully!

Ooh no, something went wrong!