Citrix Virtual Apps and Desktops SDK

Get-HypLocalizedString

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.

Get-HypLocalizedString