Citrix Virtual Apps and Desktops SDK

Get-HypLocalizedString

June 30, 2023

Contributed by:

Obtains human-readable and locale-aware status messages from a hosting connection.

Syntax

Get-HypLocalizedString [-LiteralPath] <String> [-Locale] <String> [-Category] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [[-LookupKey] <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

TODO

Parameters

Name	Description	Required?	Pipeline Input	Default Value
LiteralPath	Specifies the path to the hypervisor connection whose strings are being queried. The path must be in one of the following formats: :\Connections\ or :\Connections{}	true	true (ByValue)
Locale	The requested locale for the message, such as “en-US”.	true	false
Category	The category of the localized string.	true	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller to which the PowerShell snap-in connects. You can provide a host name or an IP address.	false	false	LocalHost. When a value is provided by any cmdlet, this value becomes the default.
LookupKey	The lookup key or message ID.	false	false

Input Type

System.String

You Can Pipe A String That Contains A Path To Get-Hyplocalizedstring (Literalpath Parameter).

Return Values

Citrix.Host.Sdk.Hypervisorstring

Get-HypLocalizedString returns zero or more instances of the HypervisorString object, each of which contain the following properties: Category <string> Specifies the category of the string, such as “Exception”. LookupKey <string> Specifies the unique lookup key or message ID within the category. DisplayText <string> Specifies the locale-aware and human-readable text.

Notes

In the case of failure, the following errors can be produced. Error Codes ———– ConnectionsPathInvalid The path provided is not to an item in the Connections subdirectory of the host service provider. HypervisorConnectionObjectNotFound The path provided could not be resolved to an existing hypervisor connection. The name or GUID is invalid. HypervisorInMaintenanceMode The hypervisor for the connection is in maintenance mode. DatabaseError An error occurred in the service while attempting a database operation. DatabaseNotConfigured The operation could not be completed because the database for the service is not configured. DataStoreException An error occurred in the service while attempting a database operation. Communication with the database failed for various reasons. CommunicationError An error occurred while communicating with the service. PermissionDenied The user does not have administrative rights to perform this operation. ExceptionThrown An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.

Examples

Example 1

c:\PS>Get-HypLocalizedString -LiteralPath XDHyp:\Connections\MyCloud -Category Exception -Locale "en-US" -LookupKey "MyCloud.InsufficientFreeIpSpace"

          Category             : Exception

          LookupKey            : MyCloud.InsufficientFreeIpSpace

          DisplayText          : There are not enough free IP addresses on the network {0}

<!--NeedCopy-->

Description

This command illustrates how a single error/exception message can be obtained for a hosting operation that failed (such as a provisioning operation). The caller specifies that they need to display the message in the en-US locale. They also specify a lookup key or message ID for the message, which will have been obtained as an exception code from the failed operation. The locale and key/ID are traded for a readable message, which also includes substitutions.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-HypLocalizedString

June 30, 2023

Contributed by:

June 30, 2023

Contributed by:

Get-HypLocalizedString

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

Return Values

Citrix.Host.Sdk.Hypervisorstring

Notes

Examples

Example 1

Description

In this article