[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / R8Lib.h

/** @file\r
Implement a utility function named R8_EfiLibCompareLanguage.\r
\r
  Copyright (c) 2007 - 2008, Intel Corporation\r
\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
**/\r
\r
#ifndef __R8_LIB_H__\r
#define __R8_LIB_H__\r
\r
/**\r
  Compare whether two names of languages are identical.\r
\r
  @param  Language1              Name of language 1\r
  @param  Language2              Name of language 2\r
\r
  @retval TRUE                   same\r
  @retval FALSE                  not same\r
\r
**/\r
BOOLEAN\r
R8_EfiLibCompareLanguage (\r
  IN  CHAR8  *Language1,\r
  IN  CHAR8  *Language2\r
  )\r
;\r
\r
/**\r
  Determine what is the current language setting. The space reserved for Lang\r
  must be at least RFC_3066_ENTRY_SIZE bytes;\r
\r
  If Lang is NULL, then ASSERT.\r
\r
  @param  Lang                   Pointer of system language. Lang will always be filled with \r
                                 a valid RFC 3066 language string. If "PlatformLang" is not\r
                                 set in the system, the default language specifed by PcdUefiVariableDefaultPlatformLang\r
                                 is returned.\r
\r
  @return  EFI_SUCCESS     If the EFI Variable with "PlatformLang" is set and return in Lang.\r
  @return  EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetCurrentLanguage (\r
  OUT     CHAR8               *Lang\r
  );\r
\r
#endif\r
\r
\r
Commit	Line	Data
fe571766	1	/** @file\r
	2	Implement a utility function named R8_EfiLibCompareLanguage.\r
	3	\r
	4	Copyright (c) 2007 - 2008, Intel Corporation\r
	5	\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __R8_LIB_H__\r
	18	#define __R8_LIB_H__\r
	19	\r
fe571766	20	/**\r
	21	Compare whether two names of languages are identical.\r
	22	\r
	23	@param Language1 Name of language 1\r
	24	@param Language2 Name of language 2\r
	25	\r
	26	@retval TRUE same\r
	27	@retval FALSE not same\r
	28	\r
	29	**/\r
	30	BOOLEAN\r
	31	R8_EfiLibCompareLanguage (\r
	32	IN CHAR8 *Language1,\r
	33	IN CHAR8 *Language2\r
	34	)\r
	35	;\r
	36	\r
8db9d51d	37	/**\r
	38	Determine what is the current language setting. The space reserved for Lang\r
	39	must be at least RFC_3066_ENTRY_SIZE bytes;\r
	40	\r
	41	If Lang is NULL, then ASSERT.\r
	42	\r
	43	@param Lang Pointer of system language. Lang will always be filled with \r
	44	a valid RFC 3066 language string. If "PlatformLang" is not\r
	45	set in the system, the default language specifed by PcdUefiVariableDefaultPlatformLang\r
	46	is returned.\r
	47	\r
	48	@return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang.\r
	49	@return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang.\r
	50	\r
	51	**/\r
	52	EFI_STATUS\r
	53	EFIAPI\r
	54	GetCurrentLanguage (\r
	55	OUT CHAR8 *Lang\r
	56	);\r
fe571766	57	\r
	58	#endif\r
	59	\r
	60	\r