Correct function comments on DxeServicesLib GetFileBufferByFilePath API.

Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13199 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4 2012-04-17 09:42:44 +00:00
parent 8321890238
commit 3556c7a248
2 changed files with 8 additions and 10 deletions

View File

@ -2,7 +2,7 @@
MDE DXE Services Library provides functions that simplify the development of DXE Drivers.
These functions help access data from sections of FFS files or from file path.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2012, 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
@ -235,7 +235,7 @@ GetSectionFromFfs (
Allocate memory to store the found image. The caller is responsible to free memory.
If File is NULL, then NULL is returned.
If FilePath is NULL, then NULL is returned.
If FileSize is NULL, then NULL is returned.
If AuthenticationStatus is NULL, then NULL is returned.
@ -248,10 +248,9 @@ GetSectionFromFfs (
@param[in] FilePath Pointer to the device path of the file that is abstracted to
the file buffer.
@param[out] FileSize Pointer to the size of the abstracted file buffer.
@param[out] AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication
status is returned.
@param[out] AuthenticationStatus Pointer to the authentication status.
@retval NULL File is NULL, or FileSize is NULL, or the file can't be found.
@retval NULL FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.
@retval other The abstracted file buffer. The caller is responsible to free memory.
**/
VOID *

View File

@ -2,7 +2,7 @@
MDE DXE Services Library provides functions that simplify the development of DXE Drivers.
These functions help access data from sections of FFS files or from file path.
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2007 - 2012, 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
which accompanies this distribution. The full text of the license may be found at
@ -578,7 +578,7 @@ GetSectionFromFfs (
Allocate memory to store the found image. The caller is responsible to free memory.
If File is NULL, then NULL is returned.
If FilePath is NULL, then NULL is returned.
If FileSize is NULL, then NULL is returned.
If AuthenticationStatus is NULL, then NULL is returned.
@ -592,10 +592,9 @@ GetSectionFromFfs (
that is absracted to the file buffer.
@param[out] FileSize The pointer to the size of the abstracted
file buffer.
@param[out] AuthenticationStatus The pointer to a caller-allocated UINT32
in which the authentication status is returned.
@param[out] AuthenticationStatus Pointer to the authentication status.
@retval NULL File is NULL, or FileSize is NULL. Or, the file can't be found.
@retval NULL FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.
@retval other The abstracted file buffer. The caller is responsible to free memory.
**/
VOID *