mirror of
				https://git.proxmox.com/git/mirror_edk2
				synced 2025-10-27 18:45:25 +00:00 
			
		
		
		
	 604371b98d
			
		
	
	
		604371b98d
		
	
	
	
	
		
			
			git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1676 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			138 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			138 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*++
 | |
| 
 | |
| Copyright (c) 2004, Intel Corporation                                                         
 | |
| All rights reserved. This program and the accompanying materials                          
 | |
| are licensed and made available under the terms and conditions of the BSD License         
 | |
| which accompanies this distribution.  The full text of the license may be found at        
 | |
| http://opensource.org/licenses/bsd-license.php                                            
 | |
|                                                                                           
 | |
| THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
 | |
| WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 | |
| 
 | |
| Module Name:
 | |
| 
 | |
|   EfiUtilityMsgs.h
 | |
| 
 | |
| Abstract:
 | |
| 
 | |
|   Defines and prototypes for common EFI utility error and debug messages.
 | |
|   
 | |
| --*/
 | |
| 
 | |
| #ifndef _EFI_UTILITY_MSGS_H_
 | |
| #define _EFI_UTILITY_MSGS_H_
 | |
| 
 | |
| #include <Common/UefiBaseTypes.h>
 | |
| 
 | |
| //
 | |
| // Status codes returned by EFI utility programs and functions
 | |
| //
 | |
| #define STATUS_SUCCESS  0
 | |
| #define STATUS_WARNING  1
 | |
| #define STATUS_ERROR    2
 | |
| #define VOID void 
 | |
| 
 | |
| typedef int STATUS;
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| extern "C" {
 | |
| #endif
 | |
| //
 | |
| // When we call Error() or Warning(), the module keeps track of the worst
 | |
| // case reported. GetUtilityStatus() will get the worst-case results, which
 | |
| // can be used as the return value from the app.
 | |
| //
 | |
| STATUS
 | |
| GetUtilityStatus (
 | |
|   void
 | |
|   );
 | |
| 
 | |
| //
 | |
| // If someone prints an error message and didn't specify a source file name,
 | |
| // then we print the utility name instead. However they must tell us the
 | |
| // utility name early on via this function.
 | |
| //
 | |
| void
 | |
| SetUtilityName (
 | |
|   CHAR8 *ProgramName
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| Error (
 | |
|   CHAR8   *FileName,
 | |
|   UINT32  LineNumber,
 | |
|   UINT32  ErrorCode,
 | |
|   CHAR8   *OffendingText,
 | |
|   CHAR8   *MsgFmt,
 | |
|   ...
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| Warning (
 | |
|   CHAR8   *FileName,
 | |
|   UINT32  LineNumber,
 | |
|   UINT32  ErrorCode,
 | |
|   CHAR8   *OffendingText,
 | |
|   CHAR8   *MsgFmt,
 | |
|   ...
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| DebugMsg (
 | |
|   CHAR8   *FileName,
 | |
|   UINT32  LineNumber,
 | |
|   UINT32  MsgLevel,
 | |
|   CHAR8   *OffendingText,
 | |
|   CHAR8   *MsgFmt,
 | |
|   ...
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| SetDebugMsgMask (
 | |
|   UINT32    MsgMask
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| ParserSetPosition (
 | |
|   CHAR8   *SourceFileName,
 | |
|   UINT32  LineNum
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| ParserError (
 | |
|   UINT32  ErrorCode,
 | |
|   CHAR8   *OffendingText,
 | |
|   CHAR8   *MsgFmt,
 | |
|   ...
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| ParserWarning (
 | |
|   UINT32  ErrorCode,
 | |
|   CHAR8   *OffendingText,
 | |
|   CHAR8   *MsgFmt,
 | |
|   ...
 | |
|   )
 | |
| ;
 | |
| 
 | |
| void
 | |
| SetPrintLimits (
 | |
|   UINT32  NumErrors,
 | |
|   UINT32  NumWarnings,
 | |
|   UINT32  NumWarningsPlusErrors
 | |
|   )
 | |
| ;
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| }
 | |
| #endif
 | |
| 
 | |
| #endif // #ifndef _EFI_UTILITY_MSGS_H_
 |