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

Article
03/04/2024

Demande que les propriétés soient incluses dans le flux de paquets.

Syntaxe

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

Paramètres

[in] cProperties

Nombre de propriétés spécifiées par le paramètre pPropertyGuids . Les valeurs valides sont comprises entre 0 et 32, inclus.

[in] pPropertyGuids

Tableau d’identificateurs globaux uniques (GUID) pour les propriétés à inclure dans le flux de paquets.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Les événements reçoivent les propriétés de paquet réelles dans l’ordre suivant.

Ordre des paquets	Description
1ère position	Contient les données de coordonnées x pour la propriété, que X ait ou non été spécifié dans la propriété DesiredPacketDescription.
2e position	Contient les données de coordonnées y pour la propriété, que Y ait ou non été spécifié dans la propriété DesiredPacketDescription.
Position de fin	Contient le status de paquet lorsque status de paquet se trouve dans la propriété DesiredPacketDescription.

Note Le résultat de la méthode IRealTimeStylus ::GetPacketDescriptionData peut ne pas correspondre aux propriétés de la méthode IRealTimeStylus ::SetDesiredPacketDescription , car certaines des propriétés peuvent ne pas être prises en charge par la tablette.

Si les propriétés de paquet spécifiées ne sont pas prises en charge par les tablettes, les données de propriété ne sont pas retournées et ne sont pas représentées dans le tableau de données de paquets. Si le même GUID apparaît plusieurs fois dans l’argument packetDescription , seule la première apparence est conservée et toutes les apparences suivantes sont filtrées. La méthode IRealTimeStylus ::SetDesiredPacketDescription Ne peut être appelée que lorsque l’objet De classe RealTimeStylus est désactivé.

La tentative de passage de 0 pour cProperties et null pour pPropertyGuids retourne E_INVALIDARG.

Les appels à la méthode IRealTimeStylus ::SetDesiredPacketDescription Sont immédiatement reflétés dans la valeur de retour de la méthode IRealTimeStylus ::GetDesiredPacketDescription Method .

Exemples

L’exemple de code C++ suivant définit les propriétés qui doivent être 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]);
    }
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP Édition Tablet PC [applications de bureau uniquement]
Serveur minimal pris en charge	Aucun pris en charge
Plateforme cible	Windows
En-tête	rtscom.h
DLL	RTSCom.dll

Voir aussi

IRealTimeStylus

IRealTimeStylus ::GetDesiredPacketDescription, méthode

IRealTimeStylus ::GetPacketDescriptionData, méthode

Classe RealTimeStylus

Partager via