From 3556c7a24857c759560daa2046949e724348e2f6 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Tue, 17 Apr 2012 09:42:44 +0000 Subject: [PATCH] Correct function comments on DxeServicesLib GetFileBufferByFilePath API. Signed-off-by: Liming Gao Reviewed-by: Jaben Carsey git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13199 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Library/DxeServicesLib.h | 9 ++++----- MdePkg/Library/DxeServicesLib/DxeServicesLib.c | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h index 596487da57..e01dd49c87 100644 --- a/MdePkg/Include/Library/DxeServicesLib.h +++ b/MdePkg/Include/Library/DxeServicesLib.h @@ -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.
+Copyright (c) 2006 - 2012, 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 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 * diff --git a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c index 5c4a182a4a..ef7c9ba9b2 100644 --- a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c +++ b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c @@ -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.
+ Copyright (c) 2007 - 2012, 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 @@ -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 * -- 2.39.2