CoGetCancelObject-Funktion (combaseapi.h)

Artikel
02/24/2024

Ruft einen Zeiger auf eine Aufrufsteuerungsschnittstelle (normalerweise ICancelMethodCalls) für das cancel-Objekt ab, das einem ausgehenden COM-Methodenaufruf entspricht, der für denselben oder einen anderen Clientthread aussteht.

Syntax

HRESULT CoGetCancelObject(
  [in]  DWORD  dwThreadId,
  [in]  REFIID iid,
  [out] void   **ppUnk
);

Parameter

[in] dwThreadId

Der Bezeichner des Threads, für den der ausstehende COM-Aufruf abgebrochen werden soll. Wenn dieser Parameter 0 ist, erfolgt der Aufruf für den aktuellen Thread.

[in] iid

Der global eindeutige Bezeichner einer Schnittstelle für das Cancel-Objekt für den abzubrechenden Aufruf. Dieses Argument wird normalerweise IID_ICancelMethodCalls.

[out] ppUnk

Empfängt die Adresse eines Zeigers auf die von riid angegebene Schnittstelle.

Rückgabewert

Diese Funktion kann die Standardrückgabewerte E_FAIL, E_INVALIDARG, E_OUTOFMEMORY und E_UNEXPECTED sowie die folgenden Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Das Aufrufsteuerungsobjekt wurde erfolgreich abgerufen.
E_NOINTERFACE	Das Objekt, für das der Aufruf ausgeführt wird, unterstützt die durch riid angegebene Schnittstelle nicht.

Hinweise

Wenn zwei oder mehr Aufrufe für denselben Thread über geschachtelte Aufrufe ausstehen, reicht die Thread-ID möglicherweise nicht aus, um den abzubrechenden Aufruf zu identifizieren. In diesem Fall gibt CoGetCancelObject eine Cancel-Schnittstelle zurück, die dem innersten Aufruf entspricht, der für den Thread aussteht und ein Cancel-Objekt registriert hat.

Diese Funktion sucht keine Abbruchobjekte für asynchrone Aufrufe.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	combaseapi.h (include Objbase.h)
Bibliothek	Ole32.lib
DLL	Ole32.dll

Freigeben über