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

[La API de ubicación de Win32 está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use la API Windows.Devices.Geolocation . ]

Recupera la cantidad de tiempo solicitada, en milisegundos, entre eventos de informe.

Sintaxis

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

Parámetros

[in] reportType

REFIID que especifica el tipo de informe para el que se va a obtener el intervalo.

[out] pMilliseconds

Dirección de un DWORD que recibe el valor del intervalo de informe, en milisegundos. Si el informe no está registrado, se establecerá en NULL. Si este valor se establece en cero, no se especifica ningún intervalo mínimo y la aplicación recibe eventos en el intervalo predeterminado del sensor de ubicación.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	reportType no era IID_ILatLongReport o IID_ICivicAddressReport.
HRESULT_FROM_WIN32(ERROR_INVALID_STATE)	El autor de la llamada no está registrado para recibir eventos para el tipo de informe especificado.
E_INVALIDARG	pMilliseconds es NULL.

Comentarios

Debe llamar a RegisterForReport antes de llamar a este método.

Ejemplos

En el ejemplo siguiente se muestra cómo llamar a GetReportInterval.

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

Requisitos

Cliente mínimo compatible	Windows 7 [solo aplicaciones de escritorio],Windows 7
Servidor mínimo compatible	No se admite ninguno
Plataforma de destino	Windows
Encabezado	locationapi.h
Archivo DLL	LocationAPI.dll

Consulte también

ILocation