IMAPISupport::Subscribe
Gilt für: Outlook 2013 | Outlook 2016
Registriert eine Empfehlungssenke, um Benachrichtigungen über MAPI zu erhalten.
HRESULT Subscribe(
LPNOTIFKEY lpKey,
ULONG ulEventMask,
ULONG ulFlags,
LPMAPIADVISESINK lpAdviseSink,
ULONG FAR * lpulConnection
);
Parameter
lpKey
[in] Ein Zeiger auf einen Benachrichtigungsschlüssel, der das Objekt der Empfehlungsquelle darstellt. Der lpKey-Parameter darf nicht NULL sein.
ulEventMask
[in] Eine Maske von Werten, die die Typen von Benachrichtigungsereignissen angeben, an denen der Aufrufer interessiert ist und in die Registrierung einbezogen werden sollte. Die folgenden Werte sind gültig:
fnevCriticalError
Registriert für Benachrichtigungen über schwerwiegende Fehler, z. B. unzureichender Arbeitsspeicher.
fnevExtended
Registriert für Benachrichtigungen zu Ereignissen, die für das jeweilige Adressbuch oder den Nachrichtenspeicheranbieter spezifisch sind.
fnevNewMail
Registriert sich für Benachrichtigungen über die Ankunft neuer Nachrichten.
fnevObjectCreated
Registriert sich für Benachrichtigungen über die Erstellung eines neuen Objekts.
fnevObjectCopied
Registriert sich für Benachrichtigungen zu einem Objekt, das kopiert wird.
fnevObjectDeleted
Registriert sich für Benachrichtigungen über ein Objekt, das gelöscht wird.
fnevObjectModified
Registriert sich für Benachrichtigungen zu einem Objekt, das geändert wird.
fnevObjectMoved
Registriert für Benachrichtigungen zu einem Objekt, das verschoben wird.
fnevSearchComplete
Registriert sich für Benachrichtigungen über den Abschluss eines Suchvorgangs.
ulFlags
[in] Eine Bitmaske von Flags, die steuert, wie Benachrichtigungen erfolgen. Das folgende Flag kann festgelegt werden:
NOTIFY_SYNC
Wenn der Aufrufer die IMAPISupport::Notify-Methode aufruft, um Benachrichtigungen für diese Empfehlungssenke zu generieren, sollte Notify alle erforderlichen Aufrufe ausführen, um Senken vor der Rückgabe zu beraten. Wenn dieses Flag nicht festgelegt ist, erfolgt die Benachrichtigung asynchron, und Rückrufe werden an die Prozesse in die Warteschlange gestellt, die abonniert und gestartet wurden, wenn diese Prozesse die Kontrolle über die CPU erlangen.
lpAdviseSink
[in] Ein Zeiger auf ein Objekt der Empfehlungssenke.
lpulConnection
[out] Ein Zeiger auf eine Verbindungsnummer ungleich null, die die Registrierung darstellt.
Rückgabewert
S_OK
Die Benachrichtigungsregistrierung war erfolgreich.
Hinweise
Die IMAPISupport::Subscribe-Methode wird für alle Dienstanbieterunterstützungsobjekte implementiert. Dienstanbieter rufen Subscribe über eine ihrer Advise-Methoden auf, damit MAPI die Benachrichtigungen verwalten kann.
Hinweise für Aufrufer
Um die MAPI-Unterstützungsmethoden für Benachrichtigungen zu verwenden, erstellen Sie einen Schlüssel für die Empfehlungsquelle des -Objekts, über das Benachrichtigungen generiert werden sollen. Der Wert des Schlüssels muss eindeutig sein und sollte bei jeder Objektänderung einfach neu generiert werden.
MAPI verwendet den Benachrichtigungsschlüssel, um nach Rückruffunktionen zu suchen, die über die HrAllocAdviseSink-Funktion für die entsprechende Empfehlungsquelle registriert sind. Übergeben Sie diesen Schlüssel an IMAPISupport::Notify , wenn Sie eine Benachrichtigung für die entsprechende Empfehlungsquelle generieren müssen.
Das NOTIFY_SYNC-Flag wirkt sich auf den Vorgang nachfolgender Aufrufe von Notify aus. Wenn Sie NOTIFY_SYNC festlegen, wird Benachrichtigen erst zurückgegeben, wenn alle erforderlichen Benachrichtigungen gesendet wurden. Wenn Sie nicht NOTIFY_SYNC festlegen, wird Notify asynchron ausgeführt und wird möglicherweise zurückgegeben, bevor alle Benachrichtigungen gesendet wurden.