ShellPkg/for: Fix potential null pointer deference

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / Clipboard.c

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.c
index 2408027abb17f0c6c0a9b2f2da85b76718e9d3cf..4d5bfb391ff5366df74c8dc307a639f8a64625f5 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.c
@@ -14,6 +14,11 @@
 \r
 #include "HexEditor.h"\r
 \r
+typedef struct {\r
+  UINT8 *Buffer;\r
+  UINTN Size;\r
+} HEFI_EDITOR_CLIPBOARD;\r
+\r
 HEFI_EDITOR_CLIPBOARD HClipBoard;\r
 \r
 //\r
@@ -24,26 +29,16 @@ HEFI_EDITOR_CLIPBOARD HClipBoardConst = {
   0\r
 };\r
 \r
+/**\r
+  Initialization function for HDiskImage.\r
+\r
+  @param[in] EFI_SUCCESS      The operation was successful.\r
+  @param[in] EFI_LOAD_ERROR   A load error occured.\r
+**/\r
 EFI_STATUS\r
 HClipBoardInit (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Initialization function for HDiskImage\r
-\r
-Arguments:  \r
-\r
-  None\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_LOAD_ERROR\r
-\r
---*/\r
 {\r
   //\r
   // basiclly initialize the HDiskImage\r
@@ -53,26 +48,16 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Initialization function for HDiskImage.\r
+\r
+  @param[in] EFI_SUCCESS      The operation was successful.\r
+  @param[in] EFI_LOAD_ERROR   A load error occured.\r
+**/\r
 EFI_STATUS\r
 HClipBoardCleanup (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Initialization function for HDiskImage\r
-\r
-Arguments:  \r
-\r
-  None\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_LOAD_ERROR\r
-\r
---*/\r
 {\r
 \r
   SHELL_FREE_NON_NULL (HClipBoard.Buffer);\r
@@ -80,6 +65,14 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Set a buffer into the clipboard.\r
+\r
+  @param[in] Buffer   The buffer to add to the clipboard.\r
+  @param[in] Size     The size of Buffer in bytes.\r
+\r
+  @retval EFI_SUCCESS   The operation was successful.\r
+**/\r
 EFI_STATUS\r
 HClipBoardSet (\r
   IN UINT8 *Buffer,\r
@@ -98,6 +91,13 @@ HClipBoardSet (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Get a buffer from the clipboard.\r
+\r
+  @param[out] Buffer   The pointer to the buffer to add to the clipboard.\r
+\r
+  @return the size of the buffer.\r
+**/\r
 UINTN\r
 HClipBoardGet (\r
   OUT UINT8  **Buffer\r