Função CoGetCancelObject (combaseapi.h)

Obtém um ponteiro para uma interface de controle de chamada, normalmente ICancelMethodCalls, no objeto cancel correspondente a uma chamada de método COM de saída pendente no mesmo thread do cliente ou em outro thread do cliente.

Sintaxe

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

Parâmetros

[in] dwThreadId

O identificador do thread no qual a chamada COM pendente deve ser cancelada. Se esse parâmetro for 0, a chamada estará no thread atual.

[in] iid

O identificador global exclusivo de uma interface no objeto cancel para que a chamada seja cancelada. Esse argumento geralmente é IID_ICancelMethodCalls.

[out] ppUnk

Recebe o endereço de um ponteiro para a interface especificada por riid.

Retornar valor

Essa função pode retornar os valores de retorno padrão E_FAIL, E_INVALIDARG, E_OUTOFMEMORY e E_UNEXPECTED, bem como os valores a seguir.

Código de retorno	Descrição
S_OK	O objeto de controle de chamada foi recuperado com êxito.
E_NOINTERFACE	O objeto no qual a chamada está sendo executada não dá suporte à interface especificada por riid.

Comentários

Se duas ou mais chamadas estiverem pendentes no mesmo thread por meio de chamadas aninhadas, a ID do thread poderá não ser suficiente para identificar a chamada a ser cancelada. Nesse caso, CoGetCancelObject retorna uma interface de cancelamento correspondente à chamada mais interna pendente no thread e registrou um objeto cancel.

Essa função não localiza objetos cancel para chamadas assíncronas.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	combaseapi.h (inclua Objbase.h)
Biblioteca	Ole32.lib
DLL	Ole32.dll