Citrix Virtual Apps and Desktops SDK

Get-HypLocalizedString

August 9, 2024

Contributed by:

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

Syntax

Get-HypLocalizedString
   [-Locale] <String>
   [-Category] <String>
   [[-LookupKey] <String>]
   [-LiteralPath] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

TODO

Examples

EXAMPLE 1

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.

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-->

Parameters

-LiteralPath

Specifies the path to the hypervisor connection whose strings are being queried. The path must be in one of the following formats:

<drive>:\Connections\<ConnectionName>

or <drive>:\Connections{<Connection Uid>}

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Locale

The requested locale for the message, such as “en-US”.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Category

The category of the localized string.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-LookupKey

The lookup key or message ID.

Type:	String
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

You can pipe a string that contains a path to Get-HypLocalizedString (LiteralPath parameter).

Outputs

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.

about_HypHostSnapin

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-HypLocalizedString

Syntax

Description

Examples

EXAMPLE 1

Parameters

-LiteralPath

-Locale

-Category

-LookupKey

CitrixCommonParameters

CommonParameters

Inputs

String

Outputs

Citrix.Host.Sdk.HypervisorString

Notes

Related Links

In this article