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   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _LIB_CLIP_BOARD_H_
  17 #define _LIB_CLIP_BOARD_H_
  18
  19 #include "HexEditor.h"
  20
  21 /**
  22   Initialization function for HDiskImage
  23
  24   @param[in] EFI_SUCCESS      The operation was successful.
  25   @param[in] EFI_LOAD_ERROR   A load error occured.
  26 **/
  27 EFI_STATUS
  28 HClipBoardInit (
  29   VOID
  30   );
  31
  32 /**
  33   Initialization function for HDiskImage.
  34
  35   @param[in] EFI_SUCCESS      The operation was successful.
  36   @param[in] EFI_LOAD_ERROR   A load error occured.
  37 **/
  38 EFI_STATUS
  39 HClipBoardCleanup (
  40   VOID
  41   );
  42
  43 /**
  44   Set a buffer into the clipboard.
  45
  46   @param[in] Buffer   The buffer to add to the clipboard.
  47   @param[in] Size     The size of Buffer in bytes.
  48
  49   @retval EFI_SUCCESS   The operation was successful.
  50 **/
  51 EFI_STATUS
  52 HClipBoardSet (
  53   IN UINT8 *Buffer,
  54   IN UINTN Size
  55   );
  56
  57 /**
  58   Get a buffer from the clipboard.
  59
  60   @param[out] Buffer   The pointer to the buffer to add to the clipboard.
  61
  62   @return the size of the buffer.
  63 **/
  64 UINTN
  65 HClipBoardGet (
  66   OUT UINT8  **Buffer
  67   );
  68
  69 #endif