ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.h

   1 /** @file
   2     Defines DiskImage - the view of the file that is visible at any point,
   3     as well as the event handlers for editing the file
   4
   5   Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _LIB_CLIP_BOARD_H_
  11 #define _LIB_CLIP_BOARD_H_
  12
  13 #include "HexEditor.h"
  14
  15 /**
  16   Initialization function for HDiskImage
  17
  18   @param[in] EFI_SUCCESS      The operation was successful.
  19   @param[in] EFI_LOAD_ERROR   A load error occured.
  20 **/
  21 EFI_STATUS
  22 HClipBoardInit (
  23   VOID
  24   );
  25
  26 /**
  27   Initialization function for HDiskImage.
  28
  29   @param[in] EFI_SUCCESS      The operation was successful.
  30   @param[in] EFI_LOAD_ERROR   A load error occured.
  31 **/
  32 EFI_STATUS
  33 HClipBoardCleanup (
  34   VOID
  35   );
  36
  37 /**
  38   Set a buffer into the clipboard.
  39
  40   @param[in] Buffer   The buffer to add to the clipboard.
  41   @param[in] Size     The size of Buffer in bytes.
  42
  43   @retval EFI_SUCCESS   The operation was successful.
  44 **/
  45 EFI_STATUS
  46 HClipBoardSet (
  47   IN UINT8 *Buffer,
  48   IN UINTN Size
  49   );
  50
  51 /**
  52   Get a buffer from the clipboard.
  53
  54   @param[out] Buffer   The pointer to the buffer to add to the clipboard.
  55
  56   @return the size of the buffer.
  57 **/
  58 UINTN
  59 HClipBoardGet (
  60   OUT UINT8  **Buffer
  61   );
  62
  63 #endif