Citrix Daas SDK

Get-BrokerConfiguredFTA

Gets any file type associations configured for an application.

Syntax

Get-BrokerConfiguredFTA
   [-ApplicationUid <Int32>]
   [-ContentType <String>]
   [-ExtensionName <String>]
   [-HandlerDescription <String>]
   [-HandlerName <String>]
   [-HandlerOpenArguments <String>]
   [-UUID <Guid>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerConfiguredFTA
   -Uid <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Gets any file type associations that are configured for content redirection to a published application.

File type association associates a file extension (such as “.txt”) with an application (such as Notepad). In a Citrix environment file type associations on a user device can be configured so that when an user clicks on a document it launches the appropriate published application. This is known as “content redirection”.

Configured file type associations are different from imported file type associations. Configured file type associations are those that are actually associated with published applications for the purposes of content redirection. Imported file type associations are lists of known file type associations for a given desktop group. See Update-BrokerImportedFTA for more information about imported file type associations.

————————– BrokerConfiguredFTA Object

The BrokerConfiguredFTA object represents a file type association configured for a published application. It contains the following properties:

  • ApplicationUid (System.Int32)

    The Uid of the application configured for the file type association.

  • ContentType (System.String)

    Content type of the file, such as “text/plain” or “application/vnd.ms-excel”.

  • ExtensionName (System.String)

    A single file extension, such as .txt, unique within the scope of a desktop group.

  • HandlerDescription (System.String)

    File type description, such as “Test Document”, “Microsoft Word Text Document”, etc.

  • HandlerName (System.String)

    File type handler name, e.g. “Word.Document.8” or TXTFILE.

  • HandlerOpenArguments (System.String)

    The arguments used for the ‘open’ action on files of this type.

  • Uid (System.Int32)

    Unique internal identifier of configured file type association.

  • UUID (System.Guid)

    UUID of the configured file type association.

Examples

EXAMPLE 1

Returns all configured file type associations.

Get-BrokerConfiguredFTA
<!--NeedCopy-->

EXAMPLE 2

Returns only configured file type associations

that have a “.txt” extension.

Get-BrokerConfiguredFTA -ExtensionName ".txt"
<!--NeedCopy-->

Parameters

-Uid

Gets only the configured file type association for

the specified unique identifier.

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

-ApplicationUid

Gets only the configured file type associations for the

specified application unique identifier.

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

-ContentType

Gets only the configured file type associations for the

specified content type (as seen in the Registry). For example,

“text/plain” or “application/msword”.

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

-ExtensionName

Gets only the configured file type associations for the

specified extension name. For example, “.txt” or “.doc”.

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

-HandlerDescription

Gets only the configured file type associations for the

specified handler description. For example, “Text Document”.

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

-HandlerName

Gets only the configured file type associations for the

specified handler name. For example, “TXTFILE” or “Word.Document.8”.

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

-HandlerOpenArguments

Gets only the configured file type associations for the

specified open argument to the handler. For example, “%1”.

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

-UUID

Gets configured file type associations with the specified value of UUID.

Type: Guid
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

-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

No input is accepted from the pipeline.

Outputs

Citrix.Broker.Admin.SDK.ConfiguredFTA

This cmdlet returns one or more ConfiguredFTA objects.

Get-BrokerConfiguredFTA