Método ILocation::GetReportInterval (locationapi.h)

[A API de Localização do Win32 está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Em vez disso, use a API Windows.Devices.Geolocation . ]

Recupera a quantidade de tempo solicitada, em milissegundos, entre eventos de relatório.

Sintaxe

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

Parâmetros

[in] reportType

REFIID que especifica o tipo de relatório para o qual obter o intervalo.

[out] pMilliseconds

O endereço de um DWORD que recebe o valor do intervalo de relatório, em milissegundos. Se o relatório não estiver registrado, ele será definido como NULL. Se esse valor for definido como zero, nenhum intervalo mínimo será especificado e seu aplicativo receberá eventos no intervalo padrão do sensor de localização.

Valor retornado

O método retorna um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	reportType era diferente de IID_ILatLongReport ou IID_ICivicAddressReport.
HRESULT_FROM_WIN32(ERROR_INVALID_STATE)	O chamador não está registrado para receber eventos para o tipo de relatório especificado.
E_INVALIDARG	pMilliseconds é NULL.

Comentários

Você deve chamar RegisterForReport antes de chamar esse método.

Exemplos

O exemplo a seguir demonstra como chamar GetReportInterval.

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

Requisitos

Cliente mínimo com suporte	Windows 7 [somente aplicativos da área de trabalho], Windows 7
Servidor mínimo com suporte	Nenhum compatível
Plataforma de Destino	Windows
Cabeçalho	locationapi.h
DLL	LocationAPI.dll

Confira também

ILocation