]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h
add comments to function declarations and definitions and updated to match coding...
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / Misc.h
... / ...
CommitLineData
1/** @file\r
2 Definitions for various line and string routines\r
3\r
4 Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef _LIB_MISC_H_\r
16#define _LIB_MISC_H_\r
17\r
18#include "HexEditor.h"\r
19\r
20/**\r
21 Advance/Retreat lines.\r
22\r
23 @param[in] Count The line number to advance/retreat.\r
24 >0 : advance\r
25 <0: retreat \r
26\r
27 @retval NULL An error occured.\r
28 @return A pointer to the line after move.\r
29**/\r
30HEFI_EDITOR_LINE *\r
31HMoveLine (\r
32 IN INTN Count\r
33 );\r
34\r
35/**\r
36 Advance/Retreat lines and set CurrentLine in BufferImage to it.\r
37\r
38 @param[in] Count The line number to advance/retreat.\r
39 >0 : advance\r
40 <0: retreat\r
41\r
42 @retval NULL An error occured.\r
43 @return A pointer to the line after move.\r
44**/\r
45HEFI_EDITOR_LINE *\r
46HMoveCurrentLine (\r
47 IN INTN Count\r
48 );\r
49\r
50/**\r
51 Free all the lines in HBufferImage.\r
52 Fields affected:\r
53 Lines\r
54 CurrentLine\r
55 NumLines\r
56 ListHead \r
57\r
58 @param[in] ListHead The list head.\r
59 @param[in] Lines The lines.\r
60\r
61 @retval EFI_SUCCESS The operation was successful.\r
62**/\r
63EFI_STATUS\r
64HFreeLines (\r
65 IN LIST_ENTRY *ListHead,\r
66 IN HEFI_EDITOR_LINE *Lines\r
67 );\r
68\r
69/**\r
70 Get the X information for the mouse.\r
71\r
72 @param[in] GuidX The change.\r
73\r
74 @return the new information.\r
75**/\r
76INT32\r
77HGetTextX (\r
78 IN INT32 GuidX\r
79 );\r
80\r
81/**\r
82 Get the Y information for the mouse.\r
83\r
84 @param[in] GuidY The change.\r
85\r
86 @return the new information.\r
87**/\r
88INT32\r
89HGetTextY (\r
90 IN INT32 GuidY\r
91 );\r
92\r
93#endif\r