Método IRealTimeStylus::SetDesiredPacketDescription (rtscom.h)

Artigo
08/25/2023

Solicita que as propriedades sejam incluídas no fluxo de pacotes.

Sintaxe

HRESULT SetDesiredPacketDescription(
  [in] ULONG      cProperties,
  [in] const GUID *pPropertyGuids
);

Parâmetros

[in] cProperties

Contagem das propriedades especificadas pelo parâmetro pPropertyGuids . Os valores válidos estão entre 0 e 32, inclusive.

[in] pPropertyGuids

A matriz de GUIDs (identificadores global exclusivos) para as propriedades solicitadas para serem incluídas no fluxo de pacotes.

Retornar valor

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Os eventos recebem as propriedades reais do pacote na ordem a seguir.

Ordem do pacote	Descrição
1ª posição	Contém os dados de coordenadas x da propriedade, independentemente de X ter sido especificado na Propriedade DesiredPacketDescription.
2ª posição	Contém os dados de coordenadas y para a propriedade, independentemente de Y ter sido especificado na Propriedade DesiredPacketDescription.
Posição final	Contém o pacote status quando status de pacotes está na propriedade DesiredPacketDescription.

Nota O resultado do Método IRealTimeStylus::GetPacketDescriptionData pode não corresponder às propriedades do método IRealTimeStylus::SetDesiredPacketDescription , pois algumas das propriedades podem não ter suporte do tablet.

Se as propriedades de pacote especificadas não forem compatíveis com os dispositivos tablet, os dados da propriedade não serão retornados e não serão representados na matriz de dados do pacote. Se o mesmo GUID aparecer várias vezes no argumento packetDescription , somente a primeira aparência será preservada e todas as aparências a seguir serão filtradas. O método método IRealTimeStylus::SetDesiredPacketDescription só pode ser chamado enquanto o objeto Classe RealTimeStylus estiver desabilitado .

Tentar passar 0 para cProperties e NULL para pPropertyGuids retorna E_INVALIDARG.

As chamadas para o método método IRealTimeStylus::SetDesiredPacketDescription são refletidas imediatamente no valor retornado do método IRealTimeStylus::GetDesiredPacketDescription .

Exemplos

O código de exemplo C++ a seguir define as propriedades que são solicitadas para serem incluídas no fluxo de pacotes.

GUID guidDesiredPacketDescription[] = { GUID_PACKETPROPERTY_GUID_X, 
                                        GUID_PACKETPROPERTY_GUID_Y, 
                                        GUID_PACKETPROPERTY_GUID_NORMAL_PRESSURE,
                                        GUID_PACKETPROPERTY_GUID_TANGENT_PRESSURE };

// Number of properties in the array
ULONG ulProperties = sizeof(guidDesiredPacketDescription) / sizeof(GUID);

// Set the packet information we'd like to get
if (SUCCEEDED(g_pRealTimeStylus->SetDesiredPacketDescription(ulProperties, guidDesiredPacketDescription)))
{
    TRACE("Set the desired packet description successfully.\n");
}

GUID* pGuids = NULL;

// See if setting the properties was successful
if (SUCCEEDED(g_pRealTimeStylus->GetDesiredPacketDescription(&ulProperties, &pGuids)))
{
    TRACE("The RealTimeStylus supports %d properties.\n", ulProperties);

    // Display the values of the GUIDs in debug output
    for (int i = 0; i < ulProperties; i++)
    {
        TRACE("GUID #%d == %d\n", i, pGuids[i]);
    }
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP Tablet PC Edition [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Nenhum compatível
Plataforma de Destino	Windows
Cabeçalho	rtscom.h
DLL	RTSCom.dll