added some comments in BaseLib

[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesTablePointerLib.h

/** @file\r
  PEI Services Table Pointer Library services\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \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
  Module Name:  PeiServicesTablePointerLib.h\r
\r
**/\r
\r
#ifndef __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
#define __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
\r
/**\r
  The function returns the pointer to PEI services.\r
  \r
  The function returns the pointer to PEI services. \r
  It will ASSERT() if the pointer to PEI services is NULL.\r
\r
  @retval  The pointer to PeiServices.\r
\r
**/\r
EFI_PEI_SERVICES **\r
GetPeiServicesTablePointer (\r
  VOID\r
  );\r
\r
#endif\r
\r