Convert-FilesFile
Transform a file and save the output to a destination path.
Syntax
Path (Default)
InputObject
Description
Transform a file and save the output to a destination path.
The command accepts files from the pipeline as -InputObject, and uses each one's Path and the connection that fetched it.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Transform a file and save the output to a destination path
Writes the file action returned.
Example 2: Act on files from the pipeline
Takes the file from the pipeline and uses its Path and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Path
Path to operate on.
- Type:
System.String - Parameter sets:
Path(required, position 0)
-Destination
Destination file path for the transformed output.
- Type:
System.String - Parameter sets:
Path(required),InputObject(required)
-TransformType
Transform type. Supported values are image_convert, document_convert, and files_transform_script_execute.
- Type:
System.String - Parameter sets:
Path(required),InputObject(required)
-TargetFormat
Destination format to create.
- Type:
System.String - Parameter sets:
Path(required),InputObject(required)
-Script
Files TransformScript source. Required when transform_type is files_transform_script_execute.
- Type:
System.String - Parameter sets:
Path,InputObject
-Width
Maximum output width for image_convert.
- Type:
System.Int64 - Parameter sets:
Path,InputObject
-Height
Maximum output height for image_convert.
- Type:
System.Int64 - Parameter sets:
Path,InputObject
-Overwrite
Overwrite existing file in the destination?
- Type:
System.Boolean - Parameter sets:
Path,InputObject
-InputObject
The file to act on, such as one written by another command of the module, from the pipeline. The command uses its Path and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.RemoteFile - Parameter sets:
InputObject(required)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: Medium. At the default
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes it ask before each change.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
FilesCom.PowerShell.Models.RemoteFile: a file from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.FileAction: the file action as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.