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

Artículo
08/25/2023

Solicita que las propiedades se incluyan en el flujo de paquetes.

Sintaxis

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

Parámetros

[in] cProperties

Recuento de las propiedades especificadas por el parámetro pPropertyGuids . Los valores válidos están comprendidos entre 0 y 32, ambos incluidos.

[in] pPropertyGuids

Matriz de identificadores únicos globales (GUID) para las propiedades solicitadas para incluirse en el flujo de paquetes.

Valor devuelto

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Los eventos reciben las propiedades de paquete reales en el orden siguiente.

Orden de paquetes	Descripción
1ª posición	Contiene los datos de coordenada x de la propiedad, independientemente de si se especificó X en la propiedad DesiredPacketDescription.
2ª posición	Contiene los datos de coordenada y de la propiedad, independientemente de si se especificó Y en la propiedad DesiredPacketDescription.
Posición final	Contiene el estado del paquete cuando el estado del paquete está en la propiedad DesiredPacketDescription.

Nota El resultado de IRealTimeStylus::GetPacketDescriptionData Method puede no coincidir con las propiedades del método IRealTimeStylus::SetDesiredPacketDescription , ya que es posible que la tableta no admita algunas de las propiedades.

Si los dispositivos de tableta no admiten las propiedades de paquete especificadas, los datos de propiedad no se devuelven y no se representan en la matriz de datos de paquetes. Si el mismo GUID aparece varias veces en el argumento packetDescription , solo se conserva la primera apariencia y se filtran todas las apariencias siguientes. Solo se puede llamar al método IRealTimeStylus::SetDesiredPacketDescription mientras el objeto Clase RealTimeStylus está deshabilitado.

Si se intenta pasar 0 para cProperties y NULL para pPropertyGuids , se devuelve E_INVALIDARG.

Las llamadas al método IRealTimeStylus::SetDesiredPacketDescription (Método) se reflejan inmediatamente en el valor devuelto del método IRealTimeStylus::GetDesiredPacketDescription.

Ejemplos

El siguiente código de ejemplo de C++ establece las propiedades que se solicitan que se incluyan 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

Requisito	Value
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