SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
7.1.10 EFI_HII_PROTOCOL.GetLine()
Summary
This function allows a program to extract a part of a string of not more than a given width. With
repeated calls, this allows a calling program to extract “lines” of text that fit inside columns. The effort
of measuring the fit of strings inside columns is localized to this call.
Prototype
EFI_STATUS
(EFIAPI *EFI_HII_GET_LINE) (
IN EFI_HII_PROTOCOL *This,
IN EFI_HII_HANDLE Handle,
IN STRING_REF Token,
IN OUT UINT16
*Index,
IN UINT16 LineWidth,
IN CHAR16 *LanguageString,
IN OUT UINT16
*BufferLength,
OUT EFI_STRING *StringBuffer
);
Parameters
This
Handle
Token
Index
LineWidth
LanguageString
BufferLength
StringBuffer
A pointer to the EFI_HII_PROTOCOL instance.
Handle on which the string resides.
The string token assigned to the string.
On input, the offset into the string where the line is to start. On
output, the index is updated to point to beyond the last character
returned in the call. The interface is designed so that repeated calls
will fill the buffer with subsequent parameters.
The maximum width of the line in units of narrow glyphs. Specific
line breaks (as in the case of two carriage returns) are still honored
resulting in separate lines. The buffer is padded to the length in
narrow spaces.
Pointer to a NULL-terminated string containing a single ISO-639-2
language identifier, indicating the language to print. If the
LanguageString is empty (starts with a NULL) the default system
language will be used to determine the language.
Pointer to the Length of the StringBuffer. If the status reports
that the buffer width is too small, this parameter is filled with the
length of the buffer needed.
The buffer designed to receive the characters in the string.
Description
62