IOfflineFilesEventsFilter::GetIncludedEvents method (cscobj.h)

Retrieves an array of OFFLINEFILES_EVENTS enumeration values describing which events should be received by the event sink. If a particular event is specified both in IOfflineFilesEventsFilter::GetIncludedEvents and IOfflineFilesEventsFilter::GetExcludedEvents, the event is excluded from this event sink.

Syntax

HRESULT GetIncludedEvents(
  [in]  ULONG               cElements,
  [out] OFFLINEFILES_EVENTS *prgEvents,
  [out] ULONG               *pcEvents
);

Parameters

[in] cElements

Specifies the maximum number of elements that can be stored in the array referenced by the prgEvents parameter.

[out] prgEvents

Contains the address of an array of OFFLINEFILES_EVENTS enumeration values. Place the OFFLINEFILES_EVENT_XXXXXX identifier in an array entry to specify that the corresponding event is desired by this event sink.

[out] pcEvents

Receives the actual number of elements written to the array referenced by the prgEvents parameter.

Return value

Return S_OK if implemented, E_NOTIMPL if not implemented.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header cscobj.h
DLL CscSvc.dll; CscObj.dll

See also

IOfflineFilesEventsFilter

IOfflineFilesEventsFilter::GetExcludedEvents

OFFLINEFILES_EVENTS