IRealTimeStylus::SetDesiredPacketDescription-Methode (rtscom.h)

Artikel
03/04/2024

Fordert die Aufnahme von Eigenschaften in den Paketdatenstrom an.

Syntax

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

Parameter

[in] cProperties

Anzahl der vom pPropertyGuids-Parameter angegebenen Eigenschaften. Gültige Werte liegen zwischen 0 und 32 (einschließlich).

[in] pPropertyGuids

Das Array von GUIDs (Globally Unique Identifiers) für die Eigenschaften, die in den Paketdatenstrom eingeschlossen werden sollen.

Rückgabewert

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Ereignisse empfangen die tatsächlichen Paketeigenschaften in der folgenden Reihenfolge.

Paketreihenfolge	BESCHREIBUNG
1. Platz	Enthält die x-Koordinatendaten für die Eigenschaft, unabhängig davon, ob X in der DesiredPacketDescription-Eigenschaft angegeben wurde.
2. Position	Enthält die y-Koordinatendaten für die Eigenschaft unabhängig davon, ob Y in der DesiredPacketDescription-Eigenschaft angegeben wurde.
Endposition	Enthält das Paket status, wenn status in der DesiredPacketDescription-Eigenschaft enthalten ist.

Hinweis Das Ergebnis der IRealTimeStylus::GetPacketDescriptionData-Methode entspricht möglicherweise nicht den Eigenschaften der IRealTimeStylus::SetDesiredPacketDescription-Methode , da einige der Eigenschaften möglicherweise nicht vom Tablet unterstützt werden.

Wenn die angegebenen Paketeigenschaften von den Tablet-Geräten nicht unterstützt werden, werden die Eigenschaftendaten nicht zurückgegeben und nicht im Paketdatenarray dargestellt. Wenn dieselbe GUID mehrmals im packetDescription-Argument angezeigt wird, wird nur die erste Darstellung beibehalten, und alle folgenden Darstellungen werden herausgefiltert. Die IRealTimeStylus::SetDesiredPacketDescription-Methode kann nur aufgerufen werden, während das RealTimeStylus Class-Objekt deaktiviert ist.

Der Versuch, 0 für cProperties und NULL für pPropertyGuids zu übergeben, gibt E_INVALIDARG zurück.

Aufrufe der IRealTimeStylus::SetDesiredPacketDescription-Methode werden sofort im Rückgabewert der IRealTimeStylus::GetDesiredPacketDescription-Methode widergespiegelt .

Beispiele

Der folgende C++-Beispielcode legt die Eigenschaften fest, die angefordert werden, um in den Paketdatenstrom eingeschlossen zu werden.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP Tablet PC Edition [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Nicht unterstützt
Zielplattform	Windows
Kopfzeile	rtscom.h
DLL	RTSCom.dll