Função GetPointerPenInfoHistory (winuser.h)

Obtém as informações baseadas em caneta associadas às entradas individuais, se houver, que foram agrupadas na mensagem atual para o ponteiro especificado (do tipo PT_PEN). A entrada mais recente está incluída no histórico retornado e é a mesma que a entrada mais recente retornada pela função GetPointerPenInfo .

Sintaxe

BOOL GetPointerPenInfoHistory(
  [in]            UINT32           pointerId,
  [in, out]       UINT32           *entriesCount,
  [out, optional] POINTER_PEN_INFO *penInfo
);

Parâmetros

[in] pointerId

Um identificador do ponteiro para o qual recuperar informações.

[in, out] entriesCount

Um ponteiro para uma variável que especifica a contagem de estruturas no buffer para o qual penInfo aponta. Se GetPointerPenInfoHistory for bem-sucedido, entriesCount será atualizado com a contagem total de estruturas disponíveis. A contagem total de estruturas disponíveis é igual ao campo historyCount na estrutura POINTER_PEN_INFO retornada por uma chamada para GetPointerPenInfo.

[out, optional] penInfo

Endereço de uma matriz de estruturas POINTER_PEN_INFO para receber as informações do ponteiro. Esse parâmetro poderá ser NULL se *entriesCount for zero.

Retornar valor

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Se o aplicativo não processar mensagens de entrada de ponteiro tão rápido quanto são geradas, algumas movimentações poderão ser agrupadas. Quando um aplicativo recebe uma mensagem de ponteiro coalescível (do tipo PT_PEN), ele pode usar a função GetPointerPenInfoHistory para recuperar informações de todas as entradas individuais, se houver, que foram agrupadas na mensagem. Observe que as informações recuperadas estão associadas à mensagem de ponteiro recuperada mais recentemente pelo thread de chamada. Depois que o thread de chamada recuperar sua próxima mensagem, as informações associadas à mensagem anterior poderão não estar mais disponíveis.

As informações recuperadas aparecem em ordem cronológica inversa, com a entrada mais recente na primeira linha da matriz retornada. A entrada mais recente é a mesma retornada pela função GetPointerPenInfo .

Se a contagem de linhas no buffer fornecido for insuficiente para manter todas as entradas de histórico disponíveis, essa função terá êxito com o buffer que contém as entradas mais recentes e *entriesCount contendo a contagem total de entradas disponíveis.

Se o quadro de ponteiro não contiver ponteiros adicionais além do ponteiro especificado, essa função terá êxito e retornará apenas as informações do ponteiro especificado.

Se as informações associadas ao quadro de ponteiro não estiverem mais disponíveis, essa função falhará com o último erro definido como ERROR_NO_DATA.

Se o thread de chamada não possuir a janela (em que a entrada foi entregue originalmente ou onde a mensagem foi encaminhada) para a qual a mensagem de ponteiro foi entregue, essa função falhará com o último erro definido como ERROR_ACCESS_DENIED.

Se o ponteiro especificado não for do tipo PT_PEN, essa função falhará com o último erro definido como ERROR_DATATYPE_MISMATCH.

Requisitos

Confira também

Funções

GetPointerFramePenInfo

GetPointerFramePenInfoHistory

GetPointerPenInfo