SyncObject Interface

Definition

Namespace:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

Represents a Send\Receive group for a user.

public interface class SyncObject : Microsoft::Office::Interop::Outlook::_SyncObject, Microsoft::Office::Interop::Outlook::SyncObjectEvents_Event

[System.Runtime.InteropServices.Guid("00063083-0000-0000-C000-000000000046")]
public interface SyncObject : Microsoft.Office.Interop.Outlook._SyncObject, Microsoft.Office.Interop.Outlook.SyncObjectEvents_Event

Public Interface SyncObject
Implements _SyncObject, SyncObjectEvents_Event

Derived

Microsoft.Office.Interop.Outlook.SyncObjectClass

Attributes

GuidAttribute

Implements

_SyncObject SyncObjectEvents_Event

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _SyncObject. For information about the event members of the COM object, see SyncObjectEvents_Event.

A Send\Receive group lets users configure different synchronization scenarios, selecting which folders and which filters apply.

Use the Item[Object] property (this in C#) to retrieve the SyncObject object from a SyncObjects object. Because the Name property is the default property of the SyncObject object, you can identify the group by name.

The SyncObject object is read-only; you cannot change its properties or create new ones. However, note that you can add one Send/Receive group using the AppFolders property which will create a Send/Receive group called Application Folders.

Properties

Application	Returns an Application object that represents the parent Outlook application for the object. Read-only. (Inherited from _SyncObject)
Class	Returns an OlObjectClass constant indicating the object's class. Read-only. (Inherited from _SyncObject)
Name	Returns a String (string in C#) value that represents the display name for the object. Read-only. (Inherited from _SyncObject)
Parent	Returns the parent Object of the specified object. Read-only. (Inherited from _SyncObject)
Session	Returns the NameSpace object for the current session. Read-only. (Inherited from _SyncObject)

Methods

Start()	Begins synchronizing a user's folders using the specified Send\Receive group. (Inherited from _SyncObject)
Stop()	Immediately ends synchronizing a user’s folders using the specified Send/Receive group. (Inherited from _SyncObject)

Events

OnError	Occurs when Microsoft Outlook encounters an error while synchronizing a user’s folders using the specified Send\Receive group. (Inherited from SyncObjectEvents_Event)
Progress	Occurs periodically while Microsoft Outlook is synchronizing a user’s folders using the specified Send\Receive group. (Inherited from SyncObjectEvents_Event)
SyncEnd	Occurs immediately after Microsoft Outlook finishes synchronizing a user’s folders using the specified Send\Receive group. (Inherited from SyncObjectEvents_Event)
SyncStart	Occurs when Microsoft Outlook begins synchronizing a user’s folders using the specified Send\Receive group. (Inherited from SyncObjectEvents_Event)