ITextStoreAnchor ::AdviseSink, méthode (textstor.h)

La méthode ITextStoreAnchor ::AdviseSink installe un nouveau récepteur de conseil à partir de l’interface ITextStoreAnchorSink ou modifie un récepteur de conseil existant.

Syntaxe

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

Paramètres

[in] riid

Spécifie l’interface récepteur. La seule valeur prise en charge est IID_ITextStoreAnchorSink.

[in] punk

Pointeur vers l’interface récepteur à conseiller. Ne peut pas être NULL.

[in] dwMask

Spécifie les événements qui notifient le récepteur de conseil. Pour plus d’informations sur les valeurs de paramètres possibles, consultez Constantes TS_AS_*.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La méthode a réussi.
E_FAIL	Impossible d’obtenir le riid de l’interface récepteur spécifié.
E_INVALIDARG	L’interface récepteur spécifiée n’est pas prise en charge.
E_UNEXPECTED	Impossible d’obtenir l’objet récepteur spécifié.

Remarques

Les appels suivants avec la même interface, représentée par le paramètre punk , sont gérés en tant que demandes de mise à jour du paramètre dwMask . Les serveurs ne doivent pas appeler la méthode AddRef sur le récepteur en réponse à une telle demande.

Les serveurs ne conservent qu’un seul point de connexion. Les tentatives de notification d’un deuxième objet récepteur échouent jusqu’à ce que l’objet récepteur d’origine soit supprimé. Les applications doivent utiliser la méthode ITextStoreAnchor ::UnadviseSink pour annuler l’inscription de l’objet récepteur lorsque les notifications ne sont pas requises.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau | Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau | Applications UWP]
Plateforme cible	Windows
En-tête	textstor.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel

Voir aussi

ITextStoreAnchor

ITextStoreAnchor ::UnadviseSink

constantes TS_AS_*