Compartilhar via


Método ITfDocumentMgr::P ush (msctf.h)

Adiciona um contexto à parte superior da pilha de contexto.

Sintaxe

HRESULT Push(
  [in] ITfContext *pic
);

Parâmetros

[in] pic

Ponteiro para o objeto ITfContext a ser adicionado à pilha. Esse objeto é obtido de uma chamada anterior para ITfDocumentMgr::CreateContext.

Retornar valor

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
O método foi bem-sucedido.
E_INVALIDARG
pic é inválido.
TF_E_STACKFULL
Não existe espaço na pilha para o contexto. A pilha de contexto tem um limite de dois contextos.
E_UNEXPECTED
Esse método foi chamado durante uma chamada ITfDocumentMgr::P op .

Comentários

O primeiro contexto adicionado à pilha torna-se o contexto main documento.

O gerenciador de TSF e os serviços de texto interagem apenas com o contexto na parte superior da pilha. Normalmente, somente o contexto do documento main está na pilha. Ocasionalmente, é necessário adicionar um segundo contexto à pilha. Por exemplo, quando um serviço de texto deve exibir uma interface do usuário modal, como uma lista de candidatos. Durante esse tempo, o serviço de texto adicionará seu contexto à pilha. Quando a interface do usuário do serviço de texto não é mais necessária, o serviço de texto remove o contexto da pilha. O contexto main retorna para a parte superior da pilha. Para simplificar esse processo e impedir que várias interfaces do usuário modais sejam exibidas, há um máximo de dois contextos permitidos na pilha.

Esse método faz com que o método ITfThreadMgrEventSink::OnPushContext de todos os coletores de eventos do gerenciador de threads instalados seja chamado. Se esse for o primeiro contexto a ser adicionado à pilha, esse método fará com que o método ITfThreadMgrEventSink::OnInitDocumentMgr de todos os coletores de eventos do gerenciador de threads instalados seja chamado.

ITfDocumentMgr::P op deve ser chamado para remover esse contexto da pilha de contexto.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho msctf.h
DLL Msctf.dll
Redistribuível TSF 1.0 no Windows 2000 Professional

Confira também

ITfContext

ITfDocumentMgr

ITfDocumentMgr::CreateContext

ITfDocumentMgr::P op

ITfThreadMgrEventSink::OnInitDocumentMgr

ITfThreadMgrEventSink::OnPushContext