tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdePkg: Refine the comments for FileHandleIsDirectory. 

Make the function comments of FileHandleIsDirectory in FileHandleLib consistent with instance implementation.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Qiu Shumin <shumin.qiu@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17630 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Qiu Shumin 2015-06-15 07:42:48 +00:00 committed by shenshushi
parent a726471baa
commit e84fb6ebe7
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
MdePkg/Include/Library/FileHandleLib.h
View File

@ -1,7 +1,7 @@
/** @file
Provides interface to EFI_FILE_HANDLE functionality.
Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2015, 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
@ -242,15 +242,14 @@ FileHandleFlush (
/**
Function to determine if a given handle is a directory handle.
If DirHandle is NULL, then ASSERT().
Open the file information on the DirHandle, and verify that the Attribute
Open the file information on the DirHandle and verify that the Attribute
includes EFI_FILE_DIRECTORY bit set.
@param[in] DirHandle The handle to open the file.
@param[in] DirHandle Handle to open file.
@retval EFI_SUCCESS DirHandle is a directory.
@retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available.
@retval EFI_INVALID_PARAMETER DirHandle is NULL.
The file information returns from FileHandleGetInfo is NULL.
@retval EFI_NOT_FOUND DirHandle is not a directory.
**/
EFI_STATUS

17
MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
View File

@ -1,7 +1,7 @@
/** @file
Provides interface to EFI_FILE_HANDLE functionality.
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. <BR>
Copyright (c) 2006 - 2015, 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
@ -383,18 +383,17 @@ FileHandleFlush (
}
/**
function to determine if a given handle is a directory handle
Function to determine if a given handle is a directory handle.
if DirHandle is NULL then return error
open the file information on the DirHandle and verify that the Attribute
Open the file information on the DirHandle and verify that the Attribute
includes EFI_FILE_DIRECTORY bit set.
@param DirHandle Handle to open file
@param[in] DirHandle Handle to open file.
@retval EFI_SUCCESS DirHandle is a directory
@retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available
@retval EFI_NOT_FOUND DirHandle is not a directory
@retval EFI_SUCCESS DirHandle is a directory.
@retval EFI_INVALID_PARAMETER DirHandle is NULL.
The file information returns from FileHandleGetInfo is NULL.
@retval EFI_NOT_FOUND DirHandle is not a directory.
**/
EFI_STATUS
EFIAPI