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

Recupera la lista de propiedades que se han solicitado que se incluyan en el flujo de paquetes.

Sintaxis

HRESULT GetDesiredPacketDescription(
  [in, out] ULONG *pcProperties,
  [out]     GUID  **ppPropertyGuids
);

Parámetros

[in, out] pcProperties

Tamaño, en bytes, del búfer ppPropertyGUIDS .

[out] ppPropertyGuids

Puntero a una lista de GUID que especifican qué propiedades, como X, Y y NormalPressure, están presentes en los datos del paquete. Para obtener una lista de propiedades predefinidas, vea PacketPropertyGuids Constants.

Valor devuelto

Para obtener una descripción de los valores devueltos, vea RealTimeStylus Classes and Interfaces (Clases e interfaces de RealTimeStylus).

Comentarios

Utilice este método para obtener la matriz de propiedades de paquete a las que se ha suscrito el objeto IRealTimeStylus llamando al método IRealTimeStylus::SetDesiredPacketDescription. Las propiedades del paquete se representan mediante una matriz de identificadores únicos globales (GUID). Para obtener una lista completa de las propiedades para las que puede recuperar métricas, consulte Las constantes PacketPropertyGuids.

El valor predeterminado es una matriz de GUID que contiene los GUID de presión X, Y y normal.

El método IRealTimeStylus::GetDesiredPacketDescription usa CoTaskMemAlloc para asignar espacio a los GUID. El llamador debe llamar a CoTaskMemFree cuando la matriz ya no sea necesaria.

Si se llama a en un objeto IRealTimeStylus secundario (configuración en cascada) y conectado, este método devuelve la descripción del paquete del elemento primario si está conectado; de lo contrario, este método devuelve el valor predeterminado (X, Y, presión) o cualquier propiedad establecida en una llamada anterior a IRealTimeStylus::SetDesiredPacketDescription Method.

En la lista siguiente se describe cómo el objeto IRealTimeStylus ordena los GUID de propiedad de paquete.

• De forma predeterminada, el método IRealTimeStylus::GetDesiredPacketDescription devuelve GUID_X, GUID_Y y GUID_NORMAL_PRESSURE.
• Los GUID X e Y siempre se devuelven en las dos primeras posiciones de la matriz mediante el método IRealTimeStylus::GetDesiredPacketDescription , si se especificaron en una llamada anterior al método IRealTimeStylus::SetDesiredPacketDescription .
• Si se especifica GUID_PACKET_STATUS en la llamada al método IRealTimeStylus::SetDesiredPacketDescription, GUID_PACKET_STATUS siempre se devuelve en la última posición de la matriz mediante el método IRealTimeStylus::GetDesiredPacketDescription.
• Si se especifican guides más de una vez en la llamada al método IRealTimeStylus::SetDesiredPacketDescription, cada GUID solo se produce una vez en la matriz devuelta por el método IRealTimeStylus::GetDesiredPacketDescription.

Ejemplos

El siguiente código de ejemplo de C++ obtiene la lista de propiedades incluidas en el flujo de paquetes.

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

Cliente mínimo compatible	Windows XP Tablet PC Edition [solo aplicaciones de escritorio]
Servidor mínimo compatible	No se admite ninguno
Plataforma de destino	Windows
Encabezado	rtscom.h
Archivo DLL	RTSCom.dll

Consulte también

IRealTimeStylus

IRealTimeStylus::SetDesiredPacketDescription (Método)

RealTimeStylus (clase)