Citrix Virtual Apps and Desktops SDK

Get-BrokerMachineStartMenuShortcutIcon

August 9, 2024

Contributed by:

Retrieves a Start Menu Shortcut icon from the specified machine.

Syntax

Get-BrokerMachineStartMenuShortcutIcon
   [-MachineName] <String>
   [-Path] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves the icon associated with a particular shortcut on a particular machine. This icon is usually used to help create a published application to access the shortcut.

Examples

EXAMPLE 1

This example retrieves all Start Menu Shortcuts from ‘MyDomain\MyMachine’, and then the icon for the first shortcut from the returned list. The icon is then associated with a published application called ‘Notepad’.

$shortcuts =  Get-BrokerMachineStartMenuShortcuts -MachineName 'MyDomain\MyMachine'
$encodedIconData =  Get-BrokerMachineStartMenuShortcutIcon -MachineName 'MyDomain\MyMachine' -Path $shortcuts[0].ShortcutPath
$brokerIcon = New-BrokerIcon -EncodedIconData $encodedIconData
Set-BrokerApplication 'Notepad' -IconUid $brokerIcon.Uid
<!--NeedCopy-->

Parameters

-MachineName

Specify the name of the machine to use for icon retrieval for the specified shortcut path. The machine can be identified by DNS name, short name, SID, or name of the form domain\machine.

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

-Path

The location of the shortcut in the specified machine whose icon is being fetched.

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

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

None

You cannot pipe input into this cmdlet.

Outputs

String

Get-BrokerMachineStartMenuShortcutIcon generates a Base64 encoded string containing the icon for the specified shortcut. This can be used as input to New-BrokerIcon cmdlet.

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-BrokerMachineStartMenuShortcutIcon

Syntax

Description

Examples

EXAMPLE 1

Parameters

-MachineName

-Path

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

String

Related Links

In this article