- This function retrieves the string specified by StringId which\r
- is associated with the specified PackageList in the language\r
- Language and copies it into the buffer specified by String. If\r
- the string specified by StringId is not present in the\r
- specified PackageList, then EFI_NOT_FOUND is returned. If the\r
- string specified by StringId is present, but not in the\r
- specified language then EFI_INVALID_LANGUAGE is returned. If\r
- the buffer specified by StringSize is too small to hold the\r
- string, then EFI_BUFFER_TOO_SMALL will be returned. StringSize\r
- will be updated to the size of buffer actually required to\r
- hold the string.\r
-\r
- @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
- \r
- @param PackageList The package list in the HII database to\r
- search for the specified string.\r
- \r
- @param Language Points to the language for the retrieved\r
- string.\r
- \r
- @param StringId The string's id, which is unique within\r
- PackageList.\r
- \r
- @param String Points to the new null-terminated string.\r
- \r
- @param StringSize On entry, points to the size of the buffer\r
- pointed to by String, in bytes. On return,\r
- points to the length of the string, in\r
- bytes.\r
- \r
- @param StringFontInfo Points to a buffer that will be callee allocated and will \r
- have the string's font information into this buffer. \r
- The caller is responsible for freeing this buffer. \r
- If the parameter is NULL a buffer will not be allocated \r
- and the string font information will not be returned.\r
- \r
- @retval EFI_SUCCESS The string was returned successfully.\r
- \r
- @retval EFI_NOT_FOUND The string specified by StringId is not\r
- available. The specified PackageList is not in the database.\r
- \r
- @retval EFI_INVALID_LANGUAGE The string specified by StringId\r
- is available but not in the\r
- specified language.\r
- \r
- @retval EFI_BUFFER_TOO_SMALL The buffer specified by\r
- StringLength is too small to\r
- hold the string.\r
- \r
- @retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
- \r