Méthode ILocationReport ::GetValue (locationapi.h)

[L’API d’emplacement Win32 est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Utilisez plutôt l’API Windows.Devices.Geolocation . ]

Récupère une valeur de propriété à partir du rapport d’emplacement.

Syntaxe

HRESULT GetValue(
  [in]  REFPROPERTYKEY pKey,
  [out] PROPVARIANT    *pValue
);

Paramètres

[in] pKey

REFPROPERTYKEY qui spécifie le nom de la propriété à récupérer.

[out] pValue

Adresse d’un PROPVARIANT qui reçoit la valeur de propriété.

Valeur retournée

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

Remarques

Les propriétés peuvent être définies par la plateforme ou par le fabricant.

Les valeurs PROPERTYKEY définies par la plateforme pour les capteurs d’emplacement sont définies dans la section Types de données des capteurs d’emplacement de sensors.h.

Voici un tableau de certaines propriétés définies par la plateforme qui sont généralement associées à des rapports d’emplacement. Ces clés de propriété ont un champ fmtid égal à SENSOR_DATA_TYPE_LOCATION_GUID. Vous trouverez des propriétés supplémentaires dans sensors.h. Si vous implémentez votre propre rapport d’emplacement à transmettre à SetReport, cette table indique les valeurs à fournir dans l’implémentation de GetValue de votre objet de rapport.

Voici un tableau d’autres propriétés définies par la plateforme qui peuvent se produire dans des rapports d’emplacement, mais qui ne sont pas spécifiques à l’emplacement. Le champ fmtid de ces clés de propriété est SENSOR_PROPERTY_COMMON_GUID.

Exemples

L’exemple suivant montre comment appeler GetValue pour obtenir une valeur de propriété. Vous devez inclure sensors.h pour utiliser la constante dans l’exemple.

PROPVARIANT pv;				
HRESULT hr = spLatLongReport->GetValue(SENSOR_DATA_TYPE_LATITUDE_DEGREES, &pv);

L’exemple suivant montre comment implémenter GetValue dans votre propre objet de rapport. Cette implémentation permet à l’appelant d’obtenir des valeurs pour plusieurs champs de rapport d’emplacement. Ce code vous oblige à inclure sensors.h et provarutil.h.

STDMETHODIMP CLocationReport::GetValue(REFPROPERTYKEY pKey, PROPVARIANT *pValue)
{
    HRESULT hr = S_OK;

    if (pKey.fmtid == SENSOR_DATA_TYPE_LOCATION_GUID) 
    {
        // properties for civic address reports
        if (pKey.pid == SENSOR_DATA_TYPE_ADDRESS1.pid)
        {
            hr = InitPropVariantFromString(m_address1, pValue);
        } 
        else if (pKey.pid == SENSOR_DATA_TYPE_ADDRESS2.pid)
        {    
            hr = InitPropVariantFromString(m_address2, pValue);
        }
        else if (pKey.pid == SENSOR_DATA_TYPE_CITY.pid)
        {
            hr = InitPropVariantFromString(m_city, pValue);
        }
        else if (pKey.pid == SENSOR_DATA_TYPE_STATE_PROVINCE.pid)
        {
            hr = InitPropVariantFromString(m_stateprovince, pValue);
        } 
        else if (pKey.pid == SENSOR_DATA_TYPE_POSTALCODE.pid)
        {
            hr = InitPropVariantFromString(m_postalcode, pValue);
        }
        else if (pKey.pid == SENSOR_DATA_TYPE_COUNTRY_REGION.pid)    
        {
            hr = InitPropVariantFromString(m_countryregion, pValue);
        }
        // properties for latitude/longitude reports
        else if (pKey.pid == SENSOR_DATA_TYPE_LATITUDE_DEGREES.pid)
        {
            hr = InitPropVariantFromDouble(m_latitude, pValue);
        } 
        else if (pKey.pid == SENSOR_DATA_TYPE_LONGITUDE_DEGREES.pid)
        {
            hr = InitPropVariantFromDouble(m_longitude, pValue);
        }
        else if (pKey.pid == SENSOR_DATA_TYPE_ERROR_RADIUS_METERS.pid)    
        {
            hr = InitPropVariantFromDouble(m_errorradius, pValue);
        }
        else 
        {
            hr = HRESULT_FROM_WIN32(ERROR_NO_DATA);
            PropVariantInit(pValue);
        }
    }
    return hr;
}

Configuration requise

Voir aussi

ILocationReport