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.

ITextStoreAnchor::UnadviseSink method

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 ITextStoreAnchor::AdviseSink method, which registers a new sink object, should be matched by a call to this method. If AdviseSink has only updated the dwMask parameter of a sink which was previously registered, a call to UnadviseSink is not required.

For example, to register a sink object, an application calls the AdviseSink method the first time. The application can then 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 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Textstor.h

IDL

Textstor.idl

DLL

Msctf.dll

See also

ITextStoreAnchor
ITextStoreAnchor::AdviseSink

 

 

Community Additions

Show:
© 2014 Microsoft