Clarify some definitions in HII Configure Routine Protocol

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9288 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2009-09-21 14:14:32 +00:00
parent 8e7b8fb4d6
commit 29c18ab53f
1 changed files with 10 additions and 13 deletions

View File

@ -56,8 +56,10 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL
instance. instance.
@param Request A null-terminated Unicode string in @param Request A null-terminated string in <MultiConfigRequest>
<MultiConfigRequest> format. format. If a NULL is passed in for the Request field,
all of the settings being abstracted by this function
will be returned in the Results field.
@param Progress On return, points to a character in the @param Progress On return, points to a character in the
Request string. Points to the string's null Request string. Points to the string's null
@ -68,11 +70,11 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
name / value pair) if the request was not name / value pair) if the request was not
successful successful
@param Results Null-terminated Unicode string in @param Results A null-terminated string in <ConfigAltResp> format
<MultiConfigAltResp> format which has all which has all values filled in for the names in the
values filled in for the names in the Request string. If the Request string was NULL, the data
Request string. String to be allocated by returned is in <MultiConfigAltResp> format. String to be
the called function. allocated by the called function.
@retval EFI_SUCCESS The Results string is filled with the @retval EFI_SUCCESS The Results string is filled with the
values corresponding to all requested values corresponding to all requested
@ -120,12 +122,7 @@ EFI_STATUS
This function allows the caller to request the current This function allows the caller to request the current
configuration for all of the current HII database. The results configuration for all of the current HII database. The results
include both the current and alternate configurations as include both the current and alternate configurations as
described in ExtractConfig() above. Implementation note: This described in ExtractConfig() above.
call has deceptively few inputs but the implementation is likely
to be somewhat complex. The requirement is to scan all IFR in
the HII database to determine the list of names and then request
the configuration using the corresponding drivers.
EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below.
@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.