ISyncSchedule::GetScheduleCookie method

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

Gets the ID of the schedule.

Syntax

HRESULT GetScheduleCookie(
  [out] SYNCSCHEDULECOOKIE *pSyncSchedCookie
);

Parameters

  • pSyncSchedCookie [out]
    Type: SYNCSCHEDULECOOKIE*

    A pointer to the schedule's identifier.

Return value

Type: HRESULT

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

Remarks

The value retrieved by ISyncSchedule::GetScheduleCookie is a unique ID assigned to the schedule when it was created.

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

Mobsync.dll

See also

ISyncSchedule

CreateSchedule

LaunchScheduleWizard