Citrix Virtual Apps and Desktops SDK

Get-BrokerMachineStartMenuShortcutIcon

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.

Get-BrokerMachineStartMenuShortcutIcon