Super-ExMerge On-line Documentation

⌘K
  2. Home
  4. Docs
  6. Super-ExMerge On-line Doc...
  8. PowerShell Cmdlet Referen...
  10. Save-SyncTask

Save-SyncTask

Use this cmdlet to save a SyncTask object to a binary file.

Export-SyncTask

  • -Task
  • -FileName
  • [-OverwriteExistingFile]

Description

Jump To:

The Save-SyncTask cmdlet is used to save a task object as a file. Exported task objects can be imported at a later time with the Import-SyncTask cmdlet.

The resulting file is a binary file that is not intended to be edited directly.

Examples

Jump To:
Example 1
  Save-SyncTask -Task $task -FileName 'c:\some\folder\MyTask.task'

This example exports the $task object to the file named ‘MyTask.task’

NOTE: There are no file extensions associated with a sync task. You can have any file extension desired for the exported file.


Parameters

Jump To:

-Task

This parameter is the SyncTask object of which to export.

Required:
Yes
Type:
SyncTask
Aliases:
None
Position:
0
Default Value:
None

-FileName

This parameter is the full path and filename in which the task object should be saved

Required:
Yes
Type:
String
Aliases:
None
Position:
1
Default Value:
None

-OverwriteExistingFile

This switch parameter determines whether and exist file with the same name as provided in -FileName is overwritten, or fails to export.

Required:
No
Type:
SwitchParameter
Aliases:
None
Position:
None
Default Value:
False

Output

Jump To:

This cmdlet does not place any data on the pipeline.

How can we help?