Click here to Skip to main content
Click here to Skip to main content
Go to top

Quietly run Microsoft's SyncToy

, 26 Oct 2006
Rate this:
Please Sign up or sign in to vote.
A console application that runs SyncToy quietly by avoiding the user interface.

Introduction

Microsoft's SyncToy has really been a godsend. I use it to syncrhonize files between two load balanced W2K3 servers that run websites. Despite what MS says, it also works on W2K3 as well as XP.

I had initially set it up as a scheduled task to run all by itself. However, when you do this, it must have a logged on user for the UI. This was unacceptable, and I looked for a suitable replacement... I found that there is a file installed with SyncToy called SyncToyEngine.dll. Thanks Microsoft for seperating the UI from the logic! This DLL is a .NET 2.0 assembly, so you can include it in any .NET project you want. Luckily, it didn't take too long to figure out how it worked either! Below is my code for a console application that simply calls the SyncToy APIs...

Prerequisites

Before using this code, it is assumed that you've already used the given UI to set up a folder pair. When you do this, the configuration is saved into a C:\Documents and Settings\[username]\My Documents\SyncToyData\SyncToyDirPairs.bin file. The file is actually a binary serialized object of type SyncToy.SyncEngineConfig. Again, thanks MS for making it so easy!!! Also in this directory, SyncToy stores the snapshot files of each of the left and right directories.

The code

  1. This is optional, but Dim WithEvents a SyncEngine object. This will allow you to view the events when files are moved.
    Dim WithEvents se1 As SyncToy.SyncEngine
    
  2. Next, get the configuration. (I used a command parameter to pass this in.)
    Dim sc As SyncToy.SyncEngineConfig
    Dim db As New System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
    Dim sr As New IO.StreamReader(Command.Replace("""", ""))
    sc = CType(db.Deserialize(sr.BaseStream), SyncToy.SyncEngineConfig)
    sr.Close()
  3. Create the new SyncEngine with the configuration.
    se1 = New SyncToy.SyncEngine(sc)
  4. Now, you must call preview() for the API to create its own SyncActions. The preview actually looks at both files and defines what the actions are to be done, if any.
    se1.Preview()
    
  5. Finally, run the sync() command...
    se1.Sync()
    

That's it! Good luck. Download the attached source file if you want a little more detail on error handling and notifying the user what's happening.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Domenic
Web Developer
United States United States
I've been writing software applications since the early 90's from ASP and VB5 to C# and ASP.NET. I am currently working on law enforcement and criminal justice applications delivered over the web. I've always been astounded by the fact that the only 2 industries that refer to customers as "users" are narcotics and software development. Wink | ;-)

Comments and Discussions

 
GeneralBiffs on Vista at .Preview Pinmemberbarry_t2-Feb-09 17:53 
QuestionUpdating Details Pinmemberhblue14-Apr-08 3:56 
GeneralAuto Sync Pinmemberjtordoya8-May-07 9:42 
GeneralNOW how about FTP Pinmembercodegalaxy11-Apr-07 2:39 
QuestionWrite SyncToy Config File PinmemberCurti McNamee15-Dec-06 8:28 
AnswerRe: Write SyncToy Config File PinmemberDomenic18-Dec-06 5:11 
GeneralRe: Write SyncToy Config File PinmemberCurti McNamee19-Dec-06 20:51 
GeneralRe: Write SyncToy Config File PinmemberDomenic20-Dec-06 2:13 
GeneralRe: Write SyncToy Config File PinmemberCurt McNamee20-Dec-06 10:32 
AnswerRe: Write SyncToy Config File Pinmemberpreydator4-Oct-10 19:30 
QuestionHow do I get it to process all the folder pairs PinmemberAToad3-Nov-06 11:20 
AnswerRe: How do I get it to process all the folder pairs PinmemberDomenic16-Nov-06 2:58 
AnswerRe: How do I get it to process all the folder pairs PinmemberShaggy Wolf5-Dec-06 11:41 
GeneralRe: How do I get it to process all the folder pairs PinmemberAToad5-Dec-06 17:21 
GeneralRe: How do I get it to process all the folder pairs PinmemberDomenic18-Dec-06 5:12 
GeneralConfig Pinmemberrayodio3-Nov-06 0:31 
GeneralRe: Config Pinmembercodesurv3-Nov-06 4:13 
QuestionWhat exactly is the "configuration" you pass on the command line? Pinmembercodesurv2-Nov-06 13:29 
AnswerRe: What exactly is the "configuration" you pass on the command line? Pinmembercodesurv2-Nov-06 14:57 
GeneralRe: What exactly is the "configuration" you pass on the command line? Pinmemberrayodio3-Nov-06 0:06 
GeneralRe: What exactly is the "configuration" you pass on the command line? Pinmemberrayodio3-Nov-06 0:13 
GeneralRe: What exactly is the "configuration" you pass on the command line? Pinmemberrayodio3-Nov-06 0:29 
AnswerRe: What exactly is the "configuration" you pass on the command line? Pinmemberchappy72111-Dec-06 20:07 
QuestionSilly Question PinmemberPavlosb31-Oct-06 23:35 
AnswerRe: Silly Question PinmemberDomenic16-Nov-06 2:54 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140922.1 | Last Updated 26 Oct 2006
Article Copyright 2006 by Domenic
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid