ITextStoreACP2::AdviseSink method

Installs a new advise sink from the ITextStoreACPSink interface or modifies an existing advise sink. The sink interface is specified by the punk parameter.

Syntax


HRESULT AdviseSink(
  [in] REFIID   riid,
  [in] IUnknown *punk,
  [in] DWORD    dwMask
);

Parameters

riid [in]

Specifies the sink interface.

punk [in]

Pointer to the sink interface. Cannot be NULL.

dwMask [in]

Specifies the events that notify the advise sink. For more information about possible parameter values, see TS_AS_* Constants.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

CONNECT_E_ADVISELIMIT

A sink interface pointer could not be obtained.

E_INVALIDARG

The specified sink interface is unsupported.

E_UNEXPECTED

The specified sink object could not be obtained.

 

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

 

 

Show: