MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibInternal.h

   1 /** @file
   2   Internal Header file for UEFI Device Path Library.
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _UEFI_DEVICEPATH_LIB_INTERNAL_H_
  16 #define _UEFI_DEVICEPATH_LIB_INTERNAL_H_
  17
  18
  19 /**
  20   The constructor function caches the pointer to DevicePathUtilites protocol.
  21
  22   The constructor function locates DevicePathUtilities protocol from protocol database.
  23   It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
  24
  25   @param  ImageHandle   The firmware allocated handle for the EFI image.
  26   @param  SystemTable   A pointer to the EFI System Table.
  27
  28   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
  29
  30 **/
  31 EFI_STATUS
  32 EFIAPI
  33 DevicePathLibConstructor (
  34   IN      EFI_HANDLE                ImageHandle,
  35   IN      EFI_SYSTEM_TABLE          *SystemTable
  36   );
  37
  38 #endif