ISyncScheduleMgr::CreateSchedule method

[The ISyncScheduleMgr::CreateSchedule method is available for use through Windows XP. It is not available in subsequent versions of Windows.]

Creates a new synchronization schedule.

Syntax

HRESULT CreateSchedule(
  [in]      LPCWSTR            pwszScheduleName,
  [in]      DWORD              dwFlags,
  [in, out] SYNCSCHEDULECOOKIE *pSyncSchedCookie,
  [out]     ISyncSchedule      **ppSyncSchedule
);

Parameters

pwszScheduleName [in]

Type: LPCWSTR

A name for the schedule. If this parameter is an empty string, a unique name is provided for you.

dwFlags [in]

Type: DWORD

One or more of the following values.

SYNCSCHEDINFO_FLAGS_READONLY (0x0001)

The schedule is read-only and cannot be altered.

SYNCSCHEDINFO_FLAGS_AUTOCONNECT (0x0002)

A network connection required for the synchronization should be requested automatically.

SYNCSCHEDINFO_FLAGS_HIDDEN (0x0004)

The item is not displayed in the synchronization schedule UI.

pSyncSchedCookie [in, out]

Type: SYNCSCHEDULECOOKIE*

A pointer to a GUID by which the schedule is identified in subsequent method calls. If this parameter is GUID_NULL on entry, a GUID is created for you and returned on exit.

ppSyncSchedule [out]

Type: ISyncSchedule**

The address of a pointer to the created schedule.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Header	Syncmgr.h
IDL	Syncmgr.idl
DLL	Shell32.dll