Metodo IRealTimeStylus::GetDesiredPacketDescription (rtscom.h)

Recupera l'elenco delle proprietà che sono state richieste per essere incluse nel flusso di pacchetti.

Sintassi

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

Parametri

[in, out] pcProperties

Dimensione, in byte, del buffer ppPropertyGUIDS .

[out] ppPropertyGuids

Puntatore a un elenco di GUID che specificano quali proprietà, ad esempio X, Y e NormalPressure, sono presenti nei dati del pacchetto. Per un elenco delle proprietà predefinite, vedere Costanti PacketPropertyGuids.

Valore restituito

Per una descrizione dei valori restituiti, vedere Classi e interfacce RealTimeStylus.

Commenti

Utilizzare questo metodo per ottenere la matrice di proprietà del pacchetto a cui l'oggetto IRealTimeStylus ha sottoscritto chiamando il metodo IRealTimeStylus::SetDesiredPacketDescription. Le proprietà dei pacchetti sono rappresentate da una matrice di identificatori univoci globali (GUID). Per un elenco completo delle proprietà per cui è possibile recuperare le metriche, vedere Le costanti PacketPropertyGuids.

Il valore predefinito è una matrice di GUID che contiene i GUID di pressione X, Y e normal.

Il metodo IRealTimeStylus::GetDesiredPacketDescription usa CoTaskMemAlloc per allocare spazio per i GUID. Il chiamante deve chiamare CoTaskMemFree quando la matrice non è più necessaria.

Se viene chiamato su un oggetto IRealTimeStylus figlio (configurazione a catena) e connesso, questo metodo restituisce la descrizione del pacchetto padre se connessa, in caso contrario questo metodo restituisce l'impostazione predefinita (X, Y, pressure) o le proprietà impostate in una chiamata precedente al metodo IRealTimeStylus::SetDesiredPacketDescription.

Nell'elenco seguente viene descritto come l'oggetto IRealTimeStylus ordina i GUID delle proprietà del pacchetto.

• Per impostazione predefinita, il metodo IRealTimeStylus::GetDesiredPacketDescription restituisce GUID_X, GUID_Y e GUID_NORMAL_PRESSURE.
• I GUID X e Y vengono sempre restituiti nelle prime due posizioni della matrice dal metodo IRealTimeStylus::GetDesiredPacketDescription , indipendentemente dal fatto che siano stati specificati in una chiamata precedente al metodo IRealTimeStylus::SetDesiredPacketDescription .
• Se GUID_PACKET_STATUS viene specificato nella chiamata al metodo IRealTimeStylus::SetDesiredPacketDescription , GUID_PACKET_STATUS viene sempre restituito nell'ultima posizione nella matrice dal metodo IRealTimeStylus::GetDesiredPacketDescription .
• Se nella chiamata al metodo IRealTimeStylus::SetDesiredPacketDescription vengono specificati più volte, ogni GUID si verifica una sola volta nella matrice restituita dal metodo IRealTimeStylus::GetDesiredPacketDescription .

Esempio

Il codice di esempio C++ seguente ottiene l'elenco delle proprietà incluse nel flusso di pacchetti.

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

Requisiti

Vedi anche

IRealTimeStylus

Metodo IRealTimeStylus::SetDesiredPacketDescription

Classe RealTimeStylus