Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -5,14 +5,14 @@
|
||||
information from configuration applications, routing the
|
||||
results to the appropriate drivers.
|
||||
|
||||
Copyright (c) 2006 - 2010, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
|
||||
This program and the accompanying materials are licensed and made available under
|
||||
the terms and conditions of the BSD License that accompanies this distribution.
|
||||
The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
@@ -30,10 +30,10 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
|
||||
This function allows the caller to request the current
|
||||
configuration for one or more named elements from one or more
|
||||
drivers. The resulting string is in the standard HII
|
||||
configuration string format. If Successful Results contains an
|
||||
configuration string format. If Successful, Results contains an
|
||||
equivalent string with "=" and the values associated with all
|
||||
names added in. The expected implementation is for each
|
||||
<ConfigRequest> substring in the Request, call the HII
|
||||
<ConfigRequest> substring in the Request to call the HII
|
||||
Configuration Routing Protocol ExtractProtocol function for the
|
||||
driver corresponding to the <ConfigHdr> at the start of the
|
||||
<ConfigRequest> substring. The request fails if no driver
|
||||
@@ -60,7 +60,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
|
||||
|
||||
@param Progress On return, points to a character in the
|
||||
Request string. Points to the string's null
|
||||
terminator if request was successful. Points
|
||||
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
|
||||
@@ -96,8 +96,8 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
|
||||
configuration extraction.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
|
||||
to most recent & before the
|
||||
error or the beginning of the
|
||||
to the most recent & before the
|
||||
error, or the beginning of the
|
||||
string.
|
||||
@retval EFI_INVALID_PARAMETER Unknown name.
|
||||
|
||||
@@ -172,7 +172,7 @@ EFI_STATUS
|
||||
offset of 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) or the
|
||||
the first name / value pair), or the
|
||||
terminating NULL if all was successful.
|
||||
|
||||
@retval EFI_SUCCESS The results have been distributed or are
|
||||
@@ -187,8 +187,8 @@ EFI_STATUS
|
||||
Results parameter would result
|
||||
in this type of error.
|
||||
|
||||
@retval EFI_NOT_FOUND Target for the specified routing data
|
||||
was not found
|
||||
@retval EFI_NOT_FOUND The target for the specified routing data
|
||||
was not found.
|
||||
|
||||
**/
|
||||
typedef
|
||||
@@ -216,12 +216,12 @@ EFI_STATUS
|
||||
|
||||
@param ConfigRequest A null-terminated string in <ConfigRequest> format.
|
||||
|
||||
@param Block Array of bytes defining the block's
|
||||
@param Block An array of bytes defining the block's
|
||||
configuration.
|
||||
|
||||
@param BlockSize Length in bytes of Block.
|
||||
@param BlockSize The length in bytes of Block.
|
||||
|
||||
@param Config Filled-in configuration string. String
|
||||
@param Config The filled-in configuration string. String
|
||||
allocated by the function. Returned only if
|
||||
call is successful. The null-terminated string
|
||||
will be <ConfigResp> format.
|
||||
@@ -230,7 +230,7 @@ EFI_STATUS
|
||||
offset of 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) or the
|
||||
the first name / value pair), or the
|
||||
terminating NULL if all was successful.
|
||||
|
||||
@retval EFI_SUCCESS The request succeeded. Progress points
|
||||
@@ -248,11 +248,11 @@ EFI_STATUS
|
||||
to the first character of
|
||||
ConfigRequest.
|
||||
|
||||
@retval EFI_NOT_FOUND Target for the specified routing data
|
||||
@retval EFI_NOT_FOUND The target for the specified routing data
|
||||
was not found. Progress points to the
|
||||
'G' in "GUID" of the errant routing
|
||||
data.
|
||||
@retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
|
||||
@retval EFI_DEVICE_ERROR The block is not large enough. Progress undefined.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Encountered non <BlockName>
|
||||
formatted string. Block is
|
||||
@@ -300,7 +300,7 @@ EFI_STATUS
|
||||
BlockLength parameter is (on input)
|
||||
shorter than required by the
|
||||
Configuration string, only the BlockSize
|
||||
parameter is updated and an appropriate
|
||||
parameter is updated, and an appropriate
|
||||
status (see below) is returned.
|
||||
|
||||
@param BlockSize The length of the Block in units of UINT8.
|
||||
@@ -313,7 +313,7 @@ EFI_STATUS
|
||||
of 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) or the terminating NULL
|
||||
name / value pair), or the terminating NULL
|
||||
if all was successful.
|
||||
|
||||
@retval EFI_SUCCESS The request succeeded. Progress points to the null
|
||||
@@ -371,7 +371,7 @@ EFI_STATUS
|
||||
and placed in the newly allocated AltCfgResp buffer.
|
||||
@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
|
||||
@retval EFI_INVALID_PARAMETER Any parameter is invalid.
|
||||
@retval EFI_NOT_FOUND Target for the specified routing data was not found.
|
||||
@retval EFI_NOT_FOUND The target for the specified routing data was not found.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
Reference in New Issue
Block a user