]>
Commit | Line | Data |
---|---|---|
47f51a06 YT |
1 | /** @file\r |
2 | Header file for implementation of UEFI Component Name(2) protocol.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
ecf98fbc | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
47f51a06 YT |
6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef __EFI_HTTP_COMPONENT_NAME_H__\r | |
10 | #define __EFI_HTTP_COMPONENT_NAME_H__\r | |
11 | \r | |
12 | /**\r | |
13 | Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r | |
14 | \r | |
15 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
16 | @param Language A pointer to a three-character ISO 639-2 language identifier.\r | |
17 | This is the language of the driver name that that the caller\r | |
18 | is requesting, and it must match one of the languages specified\r | |
19 | in SupportedLanguages. The number of languages supported by a\r | |
20 | driver is up to the driver writer.\r | |
21 | @param DriverName A pointer to the Unicode string to return. This Unicode string\r | |
22 | is the name of the driver specified by This in the language\r | |
23 | specified by Language.\r | |
24 | \r | |
25 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r | |
26 | and the language specified by Language was returned\r | |
27 | in DriverName.\r | |
28 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
29 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
30 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
31 | language specified by Language.\r | |
32 | \r | |
33 | **/\r | |
34 | EFI_STATUS\r | |
35 | EFIAPI\r | |
36 | HttpDxeComponentNameGetDriverName (\r | |
37 | IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r | |
38 | IN CHAR8 *Language,\r | |
39 | OUT CHAR16 **DriverName\r | |
40 | );\r | |
41 | \r | |
42 | /**\r | |
43 | Retrieves a Unicode string that is the user readable name of the controller\r | |
44 | that is being managed by an EFI Driver.\r | |
45 | \r | |
46 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
47 | @param ControllerHandle The handle of a controller that the driver specified by\r | |
48 | This is managing. This handle specifies the controller\r | |
49 | whose name is to be returned.\r | |
50 | @param ChildHandle The handle of the child controller to retrieve the name\r | |
51 | of. This is an optional parameter that may be NULL. It\r | |
52 | will be NULL for device drivers. It will also be NULL\r | |
53 | for a bus drivers that wish to retrieve the name of the\r | |
54 | bus controller. It will not be NULL for a bus driver\r | |
55 | that wishes to retrieve the name of a child controller.\r | |
56 | @param Language A pointer to a three character ISO 639-2 language\r | |
57 | identifier. This is the language of the controller name\r | |
58 | that the caller is requesting, and it must match one\r | |
59 | of the languages specified in SupportedLanguages. The\r | |
60 | number of languages supported by a driver is up to the\r | |
61 | driver writer.\r | |
62 | @param ControllerName A pointer to the Unicode string to return. This Unicode\r | |
63 | string is the name of the controller specified by\r | |
64 | ControllerHandle and ChildHandle in the language specified\r | |
65 | by Language, from the point of view of the driver specified\r | |
66 | by This.\r | |
67 | \r | |
68 | @retval EFI_SUCCESS The Unicode string for the user-readable name in the\r | |
69 | language specified by Language for the driver\r | |
70 | specified by This was returned in DriverName.\r | |
71 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r | |
72 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r | |
73 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
74 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
75 | @retval EFI_UNSUPPORTED The driver specified by This is not currently managing\r | |
76 | the controller specified by ControllerHandle and\r | |
77 | ChildHandle.\r | |
78 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
79 | language specified by Language.\r | |
80 | \r | |
81 | **/\r | |
82 | EFI_STATUS\r | |
83 | EFIAPI\r | |
84 | HttpDxeComponentNameGetControllerName (\r | |
85 | IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r | |
86 | IN EFI_HANDLE ControllerHandle,\r | |
87 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
88 | IN CHAR8 *Language,\r | |
89 | OUT CHAR16 **ControllerName\r | |
90 | );\r | |
91 | \r | |
92 | #endif\r |