Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITextStoreACP2::UnadviseSink method

Called by an application to indicate that it no longer requires notifications from the TSF manager. The TSF manager will release the sink interface and stop notifications.

Syntax


HRESULT UnadviseSink(
  [in]  IUnknown *punk
);

Parameters

punk [in]

Pointer to a sink object. Cannot be NULL.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

CONNECT_E_NOCONNECTION

There is no active sink object.

 

Remarks

Every call to the AdviseSink method, which registers a new sink object, should be matched by a call to this method. Calls to the AdviseSink method that only update the dwMask parameter of a sink which was previously registered, do not require a call to the UnadviseSink method.

For example, to register a sink object, an application calls the AdviseSink method the first time. After registering the sink object, the application can call the AdviseSink method again with the same sink object to change the dwMask parameter. To unregister the sink object, an application calls the UnadviseSink method.

The punk parameter must have the same COM identity as the pointer originally passed in the AdviseSink method.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Textstor.h

IDL

Textstor.idl

DLL

Msctf.dll

See also

ITextStoreACP2
AdviseSink

 

 

Community Additions

Show:
© 2014 Microsoft