RestExLib.h File Reference

#include <Protocol/RestEx.h>

Go to the source code of this file.

Functions
EFI_STATUS	RestExLibCreateChild (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_REST_EX_SERVICE_ACCESS_MODE AccessMode, IN EFI_REST_EX_CONFIG_TYPE ConfigType, IN EFI_REST_EX_SERVICE_TYPE ServiceType, OUT EFI_HANDLE *ChildInstanceHandle)

Detailed Description

This library provides help functions for REST EX Protocol.

(C) Copyright 2020 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, Ampere Computing LLC. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RestExLib.h.

Function Documentation

RestExLibCreateChild()

EFI_STATUS RestExLibCreateChild	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image,
		IN EFI_REST_EX_SERVICE_ACCESS_MODE	AccessMode,
		IN EFI_REST_EX_CONFIG_TYPE	ConfigType,
		IN EFI_REST_EX_SERVICE_TYPE	ServiceType,
		OUT EFI_HANDLE *	ChildInstanceHandle
	)

Library class public functions This function allows the caller to create child handle for specific REST server.

Parameters

[in]	Controller	The controller handle used of selected interface.
[in]	Image	The image handle used to open service.
[in]	AccessMode	Access mode of REST server.
[in]	ConfigType	Underlying configuration to communicate with REST server.
[in]	ServiceType	REST service type.
[out]	ChildInstanceHandle	The handle to receive the create child.

Return values

EFI_SUCCESS	Can't create the corresponding REST EX child instance.
EFI_INVALID_PARAMETERS	Any of input parameters is improper.

This function allows the caller to create child handle for specific REST server.

Parameters

[in]	Controller	The controller handle used of selected interface.
[in]	Image	The image handle used to open service.
[in]	AccessMode	Access mode of REST server.
[in]	ConfigType	Underlying configuration to communicate with REST server.
[in]	ServiceType	REST service type.
[out]	ChildInstanceHandle	The handle to receive the create child.

Return values

EFI_SUCCESS	Can't create the corresponding REST EX child instance.
EFI_INVALID_PARAMETERS	Any of input parameters is improper.

Definition at line 38 of file DxeRestExLib.c.