Partager via

IStore::Advise (Compact 7)

  • Article

3/12/2014

The Advise method registers a Change Notification Sink.

Syntax

HRESULT Advise(
  OlObjectType olType,
  DWORD dwFlags,
  IChangeEventSink* pSink,
  DWORD* pdwCookie
);

Parameters

  • olType
    [in] The type of Outlook object you'd like to receive notifications for.

    Note

    Restrict the notifications to the given object type. For all receiving changes of all types, use the value olUndefinedObject.

  • dwFlags
    [in] A bitmask composed of OlEventType values. Used to identify the type of information you'd like to be included in the notifications.
  • pSink
    [in] A pointer to the callback sink for the notifications.

  • pdwCookie
    [out, retval] The identifier for this particular Change Notification Instance.

    Note

    You use this value to unregister the Change Notification Sink (that is, you pass it into the IStore::Unadvise method).

Return Value

The Advise method returns the following standard HRESULT values.

  • S_OK
    The operation completed successfully.
  • E_FAIL
    The operation failed due to an unspecified error.
  • E_INVALIDARG
    The operation failed because one (or more) of the arguments is not valid.
  • E_OUTOFMEMORY
    The operation failed because it needs more memory resources.
  • E_UNEXPECTED
    The operation failed due to an unexpected failure.

Remarks

New for Windows Embedded Compact 7.

Requirements

Header

pimstore.h

Library

Pimstore.lib

See Also

Reference

IStore
IChangeEventSink::OnEvent
OlObjectType
IStore::Unadvise