ILocationReport::GetValue メソッド (locationapi.h)

[Win32 Location API は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、 Windows.Devices.Geolocation API を使用します。 ]

場所レポートからプロパティ値を取得します。

構文

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

パラメーター

[in] pKey

取得するプロパティの名前を指定する REFPROPERTYKEY。

[out] pValue

プロパティ値を受け取る PROPVARIANT のアドレス。

戻り値

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

プロパティは、プラットフォーム定義または製造元定義の場合があります。

場所センサーのプラットフォーム定義 PROPERTYKEY 値は、sensors.h の場所センサーのデータ型セクションで定義されます。

一般的に場所レポートと関連付けされるプラットフォーム定義のプロパティの一覧を次に示します。 これらのプロパティ キーには、SENSOR_DATA_TYPE_LOCATION_GUIDと等しい fmtid フィールドがあります。 その他のプロパティは sensors.h にあります。 SetReport に渡す独自の場所レポートを実装する場合、このテーブルは、レポート オブジェクトの GetValue の実装で指定する必要がある値を示します。

次に示す表は、場所レポートで発生する可能性がありますが、場所に固有のものではありません。プラットフォームで定義された他のプロパティの表です。 これらのプロパティ キーの fmtid フィールドは SENSOR_PROPERTY_COMMON_GUID。

例

次の例では、 GetValue を呼び出してプロパティ値を取得する方法を示します。 この例の 定数を使用するには、sensors.h を含める必要があります。

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

次の例は、独自のレポート オブジェクトに GetValue を 実装する方法を示しています。 この実装により、呼び出し元は複数の場所レポート フィールドの値を取得できます。 このコードでは、sensors.h と 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;
}

要件

こちらもご覧ください

ILocationReport