Метод ILocation::GetReportInterval (locationapi.h)

[API расположения Win32 доступен для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Вместо этого используйте API Windows.Devices.Geolocation . ]

Извлекает запрошенное количество времени (в миллисекундах) между событиями отчета.

Синтаксис

HRESULT GetReportInterval(
  [in]  REFIID reportType,
  [out] DWORD  *pMilliseconds
);

Параметры

[in] reportType

REFIID , указывающий тип отчета, для которого требуется получить интервал.

[out] pMilliseconds

Адрес DWORD , получающего значение интервала отчета, в миллисекундах. Если отчет не зарегистрирован, для этого отчета будет задано значение NULL. Если это значение равно нулю, минимальный интервал не указан, и приложение получает события в интервале по умолчанию датчика расположения.

Возвращаемое значение

Метод возвращает HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Код возврата	Описание
S_OK	Метод выполнен успешно.
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	параметр reportType отличается от IID_ILatLongReport или IID_ICivicAddressReport.
HRESULT_FROM_WIN32(ERROR_INVALID_STATE)	Вызывающий объект не зарегистрирован для получения событий для указанного типа отчета.
E_INVALIDARG	pMilliseconds имеет значение NULL.

Комментарии

Перед вызовом этого метода необходимо вызвать RegisterForReport .

Примеры

В следующем примере показано, как вызвать GetReportInterval.

DWORD reportInterval = 0;
HRESULT hr = spLocation->GetReportInterval(IID_ILatLongReport, &reportInterval);

Требования

Минимальная версия клиента	Windows 7 [только классические приложения],Windows 7
Минимальная версия сервера	Ни одна версия не поддерживается
Целевая платформа	Windows
Header	locationapi.h
DLL	LocationAPI.dll

См. также раздел

ILocation