ISpNotifySource::SetNotifySink

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method sets up an ISpNotifySource object to make free-threaded notification calls through ISpNotifySink::Notify. Because free-threaded notifications can occur on any thread at any point during execution, they are extremely prone to deadlocks and re-entrancy problems. See the documentation for ISpNotifySink for more details. Most applications will find using one of the other notification mechanisms much easier to use.

Syntax

HRESULT SetNotifySink(
  ISpNotifySink* pNotifySink
);

Parameters

  • pNotifySink
    [in] Pointer to ISpNotifySink for the current notify sink. If pNotifySink is NULL, any current notification mechanism (notify sink, window message, callback, or Win32 event) is removed.

Return Value

The following table shows the possible return values.

Value Description

S_OK

Function completed successfully.

E_INVALIDARG

Interface pointer is invalid.

FAILED(hr)

Appropriate error message.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpNotifySource
SAPI Interfaces