ILocation::Metode SetReportInterval (locationapi.h)

[API Lokasi Win32 tersedia untuk digunakan dalam sistem operasi yang ditentukan di bagian Persyaratan. Ini dapat diubah atau tidak tersedia dalam versi berikutnya. Sebagai gantinya, gunakan WINDOWS.Devices.Geolocation API. ]

Menentukan jumlah waktu minimum yang diminta, dalam milidetik, di antara peristiwa laporan.

Sintaks

HRESULT SetReportInterval(
  [in] REFIID reportType,
  [in] DWORD  millisecondsRequested
);

Parameter

[in] reportType

REFIID yang menentukan jenis laporan untuk mengatur interval.

[in] millisecondsRequested

DWORD yang berisi nilai interval laporan, dalam milidetik. Jika nilai ini nol, tidak ada interval minimum yang ditentukan dan aplikasi Anda menerima peristiwa pada interval default sensor lokasi.

Mengembalikan nilai

Metode mengembalikan HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil.
HRESULT_FROM_WIN32(ERROR_INVALID_STATE)	Pemanggil tidak terdaftar untuk menerima peristiwa untuk jenis laporan yang ditentukan.
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	reportType selain IID_ILatLongReport atau IID_ICivicAddressReport.

Keterangan

Interval yang Anda minta dengan menggunakan metode ini mewakili jumlah waktu terpendek antara peristiwa. Ini berarti Bahwa Anda meminta untuk menerima pemberitahuan peristiwa tidak lebih sering dari yang ditentukan, tetapi waktu yang berlalu mungkin jauh lebih lama. Gunakan metode ini untuk membantu memastikan bahwa pemberitahuan peristiwa tidak menggunakan lebih banyak sumber daya prosesor daripada yang diperlukan.

Tidak dijamin bahwa permintaan Anda untuk interval laporan tertentu akan ditetapkan oleh penyedia lokasi. Panggil GetReportInterval untuk menemukan pengaturan interval laporan yang sebenarnya.

Interval laporan nol berarti bahwa tidak ada interval minimum yang ditentukan, dan aplikasi mungkin menerima peristiwa pada frekuensi sensor lokasi mengirim peristiwa.

Contoh

Contoh berikut menunjukkan cara memanggil SetReportInterval.

// Set the latitude/longitude report interval to 1000 milliseconds
HRESULT hr = spLocation->SetReportInterval(IID_ILatLongReport, 1000);

Persyaratan

Klien minimum yang didukung	Windows 7 [hanya aplikasi desktop],Windows 7
Server minimum yang didukung	Tidak ada yang didukung
Target Platform	Windows
Header	locationapi.h
DLL	LocationAPI.dll

Lihat juga

ILocation