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

Récupère la liste des propriétés qui ont été demandées pour être incluses dans le flux de paquets.

Syntaxe

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

Paramètres

[in, out] pcProperties

Taille, en octets, de la mémoire tampon ppPropertyGUIDS .

[out] ppPropertyGuids

Pointeur vers une liste de GUID spécifiant les propriétés, telles que X, Y et NormalPressure, qui sont présentes dans les données de paquet. Pour obtenir la liste des propriétés prédéfinies, consultez Constantes PacketPropertyGuids.

Valeur retournée

Pour obtenir une description des valeurs de retour, consultez Classes et interfaces RealTimeStylus.

Notes

Utilisez cette méthode pour obtenir le tableau des propriétés de paquet auxquelles l’objet IRealTimeStylus s’est abonné en appelant la méthode IRealTimeStylus::SetDesiredPacketDescription. Les propriétés de paquet sont représentées par un tableau d’identificateurs globaux uniques (GUID). Pour obtenir la liste complète des propriétés pour lesquelles vous pouvez récupérer des métriques, consultez constantes PacketPropertyGuids.

La valeur par défaut est un tableau de GUID qui contient les GUID de pression X, Y et normale.

La méthode IRealTimeStylus::GetDesiredPacketDescription utilise CoTaskMemAlloc pour allouer de l’espace pour les GUID. L’appelant doit appeler CoTaskMemFree lorsque le tableau n’est plus nécessaire.

Si elle est appelée sur un objet IRealTimeStylus enfant (configuration en cascade) et connectée, cette méthode retourne la description du paquet parent si elle est connectée. Sinon, cette méthode retourne la valeur par défaut (X, Y, pressure) ou les propriétés définies dans un appel précédent à la méthode IRealTimeStylus::SetDesiredPacketDescription.

La liste suivante décrit comment l’objet IRealTimeStylus classe les GUID de propriété de paquet.

• Par défaut, la méthode IRealTimeStylus::GetDesiredPacketDescription method retourne GUID_X, GUID_Y et GUID_NORMAL_PRESSURE.
• Les GUID X et Y sont toujours retournés dans les deux premières positions du tableau par la méthode IRealTimeStylus::GetDesiredPacketDescription, qu’ils aient été spécifiés dans un appel précédent à la méthode IRealTimeStylus::SetDesiredPacketDescription.
• Si GUID_PACKET_STATUS est spécifié dans l’appel à la méthode IRealTimeStylus::SetDesiredPacketDescription , GUID_PACKET_STATUS est toujours retourné à la dernière position du tableau par la méthode IRealTimeStylus::GetDesiredPacketDescription .
• Si des GUID sont spécifiés plusieurs fois dans l’appel à la méthode IRealTimeStylus::SetDesiredPacketDescription , chaque GUID ne se produit qu’une seule fois dans le tableau retourné par la méthode IRealTimeStylus::GetDesiredPacketDescription .

Exemples

L’exemple de code C++ suivant obtient la liste des propriétés incluses dans le flux de paquets.

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]);
    }
}

Spécifications

Voir aussi

IRealTimeStylus

IRealTimeStylus::SetDesiredPacketDescription, méthode

Classe RealTimeStylus