Citrix Daas SDK

Get-BrokerIcon

Get stored icons.

Syntax

Get-BrokerIcon
   [-Metadata <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerIcon
   -Uid <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerIcon
   -FileName <String>
   [-ServerName <String>]
   [-Index <Int32>]
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Reads a specific icon by Uid, or enumerates icons by passing no Uid.

————————– BrokerIcon Object

The BrokerIcon object represents a single instance of an icon. It contains the following properties:

  • EncodedIconData (System.String)

    The Base64 encoded .ICO format of the icon.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>)

    Metadata for this command

  • Uid (System.Int32)

    The UID of the icon itself.

Examples

EXAMPLE 1

Enumerate all icons.

Get-BrokerIcon
<!--NeedCopy-->

EXAMPLE 2

Get the icon with Uid 1.

Get-BrokerIcon -Uid 1
<!--NeedCopy-->

EXAMPLE 3

Retrieves the icon data from a file named “icon1.dll” on this computer. If this DLL contains multiple icons, all of them are returned in sequence.

Get-BrokerIcon -FileName icon1.dll
<!--NeedCopy-->

EXAMPLE 4

Retrieves only the first icon from the “c:\icons\icon1.dll” file on Server1.

Get-BrokerIcon -FileName c:\icons\icon1.dll -ServerName Server1 -Index 0
<!--NeedCopy-->

EXAMPLE 5

Retrieves the icon data for an application named “app1.exe”, contained in an application profile named “app1.profile” located on a file share path “\\SERVER1\Share”. Returns only the first icon associated with that profiled application.

Get-BrokerIcon -FileName \\Server1\Share\app1.profile app1.exe -Index 0
<!--NeedCopy-->

Parameters

-Uid

Gets only the icon specified by unique identifier.

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-FileName

Specifies the name of a file from which to read the icon data. If the ServerName parameter is used, the FileName must be an absolute path.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ServerName

Specifies the name of the server. If the -FileName parameter refers to content or to a URL, the icon associated with the file type or URL is retrieved from the given server. Therefore, the server specified should have a file type handler installed for the given file type. If a local file path is specified, the server name refers to the server on which the file is located. If a UNC path is specified, the server name is unused.

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

-Index

Specifies the zero-based icon resource index. For example, to select the first icon, specify an index of 0. Alternatively, to select the third icon, specify an index of 2. If the specified index is larger than the number of icons in the source file or profiled application, an error will be returned.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Type: String[]
Position: Named
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

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.Icon

Returns an Icon object for each enumerated icon.

CtxIcon

Returns a list of zero or more icons, each in CtxIcon format. The CtxIcon.IconData property is the icon in standard Microsoft ICO format.

Get-BrokerIcon