ILocation::GetReportInterval メソッド (locationapi.h)
[Win32 Location API は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、 Windows.Devices.Geolocation API を使用します。 ]
レポート イベント間の要求された時間をミリ秒単位で取得します。
構文
HRESULT GetReportInterval(
[in] REFIID reportType,
[out] DWORD *pMilliseconds
);
パラメーター
[in] reportType
間隔を取得するレポートの種類を指定する REFIID。
[out] pMilliseconds
レポート間隔の値を受け取る DWORD のアドレス (ミリ秒単位)。 レポートが登録されていない場合、これは NULL に設定されます。 この値が 0 に設定されている場合、最小間隔は指定されておらず、アプリケーションはロケーション センサーの既定の間隔でイベントを受信します。
戻り値
このメソッドは HRESULT を返します。 有効な値を次の表に示しますが、これ以外にもあります。
| リターン コード | 説明 |
|---|---|
|
メソッドが成功しました。 |
|
reportType は 、IID_ILatLongReport または IID_ICivicAddressReport以外でした。 |
|
呼び出し元は、指定されたレポートの種類のイベントを受信するように登録されていません。 |
|
pMilliseconds は NULL です。 |
解説
このメソッドを呼び出す前に 、RegisterForReport を呼び出す必要があります。
例
次の例では、 GetReportInterval を呼び出す方法を示します。
DWORD reportInterval = 0;
HRESULT hr = spLocation->GetReportInterval(IID_ILatLongReport, &reportInterval);
要件
| サポートされている最小のクライアント | Windows 7 [デスクトップ アプリのみ],Windows 7 |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | locationapi.h |
| [DLL] | LocationAPI.dll |