pointer verification (not NULL) and buffer overrun fixes.

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Parse.c

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Parse.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Parse.c
index 927c8d972993dbd373d51baa468a769fa3aad0b8..1cdc9e32e302dc6e467bdebfdd61da8cbe9455e2 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Parse.c
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Parse.c
@@ -1,7 +1,7 @@
 /** @file\r
   Main file for Parse shell level 2 function.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -14,6 +14,19 @@
 \r
 #include "UefiShellLevel2CommandsLib.h"\r
 \r
+/**\r
+  Do the actual parsing of the file.  the file should be SFO output from a \r
+  shell command or a similar format.\r
+\r
+  @param[in] FileName               The filename to open.\r
+  @param[in] TableName              The name of the table to find.\r
+  @param[in] ColumnIndex            The column number to get.\r
+  @param[in] TableNameInstance      Which instance of the table to get (row).\r
+  @param[in] ShellCommandInstance   Which instance of the command to get.\r
+\r
+  @retval SHELL_NOT_FOUND     The requested instance was not found.\r
+  @retval SHELL_SUCCESS       The operation was successful.\r
+**/\r
 SHELL_STATUS\r
 EFIAPI\r
 PerformParsing(\r