DevicePathToText.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_DEVICE_PATH_TO_TEXT_PROTOCOL

Macros
#define	EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID

Typedefs
typedef CHAR16 *(EFIAPI *	EFI_DEVICE_PATH_TO_TEXT_NODE) (IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
typedef CHAR16 *(EFIAPI *	EFI_DEVICE_PATH_TO_TEXT_PATH) (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)

Variables
EFI_GUID	gEfiDevicePathToTextProtocolGuid

Detailed Description

EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0. This protocol provides service to convert device nodes and paths to text.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DevicePathToText.h.

Macro Definition Documentation

EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID

#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID

Value:

  { \
    0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } \
  }

Device Path To Text protocol

Definition at line 16 of file DevicePathToText.h.

Typedef Documentation

EFI_DEVICE_PATH_TO_TEXT_NODE

typedef CHAR16 *(EFIAPI * EFI_DEVICE_PATH_TO_TEXT_NODE) (IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)

Convert a device node to its text representation.

Parameters

DeviceNode	Points to the device node to be converted.
DisplayOnly	If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts	If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

Return values

a_pointer	a pointer to the allocated text representation of the device node data
NULL	if DeviceNode is NULL or there was insufficient memory.

Definition at line 37 of file DevicePathToText.h.

EFI_DEVICE_PATH_TO_TEXT_PATH

typedef CHAR16 *(EFIAPI * EFI_DEVICE_PATH_TO_TEXT_PATH) (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)

Convert a device path to its text representation.

Parameters

DevicePath	Points to the device path to be converted.
DisplayOnly	If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts	The AllowShortcuts is FALSE, then the shortcut forms of text representation for a device node cannot be used.

Return values

a_pointer	a pointer to the allocated text representation of the device node.
NULL	if DevicePath is NULL or there was insufficient memory.

Definition at line 60 of file DevicePathToText.h.