ComponentName.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
2N/A UEFI Component Name(2) protocol implementation for UDP6 driver. 2N/A Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR> 2N/A This program and the accompanying materials 2N/A are licensed and made available under the terms and conditions of the BSD License 2N/A which accompanies this distribution. The full text of the license may be found at 2N/A THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 2N/A WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 2N/A// EFI Component Name Functions 2N/A Retrieves a Unicode string that is the user-readable name of the driver. 2N/A This function retrieves the user-readable name of a driver in the form of a 2N/A Unicode string. If the driver specified by This has a user-readable name in 2N/A the language specified by Language, then a pointer to the driver name is 2N/A returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 2N/A by This does not support the language specified by Language, 2N/A then EFI_UNSUPPORTED is returned. 2N/A @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 2N/A EFI_COMPONENT_NAME_PROTOCOL instance. 2N/A @param[in] Language A pointer to a Null-terminated ASCII string 2N/A array indicating the language. This is the 2N/A language of the driver name that the caller is 2N/A requesting, and it must match one of the 2N/A languages specified in SupportedLanguages. The 2N/A number of languages supported by a driver is up 2N/A to the driver writer. Language is specified 2N/A in RFC 4646 or ISO 639-2 language code format. 2N/A @param[out] DriverName A pointer to the Unicode string to return. 2N/A This Unicode string is the name of the 2N/A driver specified by This in the language 2N/A specified by Language. 2N/A @retval EFI_SUCCESS The Unicode string for the Driver specified by 2N/A This and the language specified by Language was 2N/A returned in DriverName. 2N/A @retval EFI_INVALID_PARAMETER Language is NULL. 2N/A @retval EFI_INVALID_PARAMETER DriverName is NULL. @retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language. Retrieves a Unicode string that is the user-readable name of the controller that is being managed by a driver. This function retrieves the user-readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned. @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. @param[in] ControllerHandle The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be @param[in] ChildHandle The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a @param[in] Language A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format. @param[out] ControllerName A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver @retval EFI_SUCCESS The Unicode string for the user-readable name in the language specified by Language for the driver specified by This was returned in @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER ControllerName is NULL. @retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle. @retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language. // EFI Component Name Protocol // EFI Component Name 2 Protocol L
"UDP6 Network Service Driver" Retrieves a Unicode string that is the user-readable name of the driver. This function retrieves the user-readable name of a driver in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned. @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. @param[in] Language A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format. @param[out] DriverName A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language @retval EFI_SUCCESS The Unicode string for the Driver specified by This and the language specified by Language was @retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER DriverName is NULL. @retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language. Retrieves a Unicode string that is the user-readable name of the controller that is being managed by a driver. This function retrieves the user-readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned. @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. @param[in] ControllerHandle The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be @param[in] ChildHandle The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a @param[in] Language A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format. @param[out] ControllerName A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver @retval EFI_SUCCESS The Unicode string for the user-readable name in the language specified by Language for the driver specified by This was returned in @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER ControllerName is NULL. @retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle. @retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language.