Share via

Sync Property [Visio 2003 SDK Documentation]

  • Article

Returns a Microsoft Office Sync object that provides information about the status of the active document in a shared workspace and the ability to perform a set of actions.

objRet = object.Sync

objRet   The Sync object returned.

object    Required. An expression that returns a Document object.

Version added

2003

Remarks

If the Sync object is unavailable because the synchronization engine fails to respond, the following error message is displayed: "The synchronization engine is not available."

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the Sync property to get a Sync object and get the status of the active document in a shared workspace.

Public Sub Sync_Example

    Dim vsoSync As Sync
    Dim currentStatus As Status

    Set vsoSync = ActiveDocument.Sync  
    Set currentStatus = vsoSync.Status 

    If currentStatus = MsoSyncStatusLatest 

         Msgbox "You have the most up-to-date copy."

    Else

         Msgbox "You need to update."

   End if
                
End Sub

Applies to | Document object

See Also | Sync property