This function accepts a <MultiKeywordResp> formatted string, finds the associated keyword owners, creates a <MultiConfigResp> string from it and forwards it to the EFI_HII_ROUTING_PROTOCOL.RouteConfig function.
If there is an issue in resolving the contents of the KeywordString, then the function returns an error and also sets the Progress and ProgressErr with the appropriate information about where the issue occurred and additional data about the nature of the issue.
In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND error is generated during processing the second or later keyword element, the system storage associated with earlier keywords is not modified. All elements of the KeywordString must successfully pass all tests for format and access prior to making any modifications to storage.
In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString containing multiple keywords, the state of storage associated with earlier keywords is undefined.
- Parameters
-
| This | Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance. |
| KeywordString | A null-terminated string in <MultiKeywordResp> format. |
| Progress | On return, points to a character in the KeywordString. Points to the string's NULL terminator if the request was successful. Points to the most recent '&' before the first failing name / value pair (or the beginning of the string if the failure is in the first name / value pair) if the request was not successful. |
| ProgressErr | If during the processing of the KeywordString there was a failure, this parameter gives additional information about the possible source of the problem. The various errors are defined in "Related Definitions" below. |
- Return values
-
| EFI_SUCCESS | The specified action was completed successfully. |
| EFI_INVALID_PARAMETER | One or more of the following are TRUE:
- KeywordString is NULL.
- Parsing of the KeywordString resulted in an error. See Progress and ProgressErr for more data.
|
| EFI_NOT_FOUND | An element of the KeywordString was not found. See ProgressErr for more data. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. See ProgressErr for more data. |
| EFI_ACCESS_DENIED | The action violated system policy. See ProgressErr for more data. |
| EFI_DEVICE_ERROR | An unexpected system error occurred. See ProgressErr for more data. |
This function accepts a <MultiKeywordRequest> formatted string, finds the underlying keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.
If there is an issue in resolving the contents of the KeywordString, then the function returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the appropriate information about where the issue occurred and additional data about the nature of the issue.
In the case when KeywordString is NULL, or contains multiple keywords, or when EFI_NOT_FOUND is generated while processing the keyword elements, the Results string contains values returned for all keywords processed prior to the keyword generating the error but no values for the keyword with error or any following keywords.
- Parameters
-
| This | Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance. |
| NameSpaceId | A null-terminated string containing the platform configuration language to search through in the system. If a NULL is passed in, then it is assumed that any platform configuration language with the prefix of "x-UEFI-" are searched. |
| KeywordString | A null-terminated string in <MultiKeywordRequest> format. If a NULL is passed in the KeywordString field, all of the known keywords in the system for the NameSpaceId specified are returned in the Results field. |
| Progress | On return, points to a character in the KeywordString. Points to the string's NULL terminator if the request was successful. Points to the most recent '&' before the first failing name / value pair (or the beginning of the string if the failure is in the first name / value pair) if the request was not successful. |
| ProgressErr | If during the processing of the KeywordString there was a failure, this parameter gives additional information about the possible source of the problem. See the definitions in SetData() for valid value definitions. |
| Results | A null-terminated string in <MultiKeywordResp> format is returned which has all the values filled in for the keywords in the KeywordString. This is a callee-allocated field, and must be freed by the caller after being used. |
- Return values
-
| EFI_SUCCESS | The specified action was completed successfully. |
| EFI_INVALID_PARAMETER | One or more of the following are TRUE: 1.Progress, ProgressErr, or Results is NULL. 2.Parsing of the KeywordString resulted in an error. See Progress and ProgressErr for more data. |
| EFI_NOT_FOUND | An element of the KeywordString was not found. See ProgressErr for more data. |
| EFI_NOT_FOUND | The NamespaceId specified was not found. See ProgressErr for more data. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. See ProgressErr for more data. |
| EFI_ACCESS_DENIED | The action violated system policy. See ProgressErr for more data. |
| EFI_DEVICE_ERROR | An unexpected system error occurred. See ProgressErr for more data. |
1.8.6 
