Partager via


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

[L’API d’emplacement Win32 est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Utilisez plutôt l’API Windows.Devices.Geolocation . ]

Récupère la durée demandée, en millisecondes, entre les événements de rapport.

Syntaxe

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

Paramètres

[in] reportType

REFIID qui spécifie le type de rapport pour lequel obtenir l’intervalle.

[out] pMilliseconds

Adresse d’un DWORD qui reçoit la valeur d’intervalle de rapport, en millisecondes. Si le rapport n’est pas inscrit, il est défini sur NULL. Si cette valeur est définie sur zéro, aucun intervalle minimal n’est spécifié et votre application reçoit des événements à l’intervalle par défaut du capteur d’emplacement.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Code de retour Description
S_OK
S_OK
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
reportType n’était pas IID_ILatLongReport ou IID_ICivicAddressReport.
HRESULT_FROM_WIN32(ERROR_INVALID_STATE)
L’appelant n’est pas inscrit pour recevoir des événements pour le type de rapport spécifié.
E_INVALIDARG
pMilliseconds a la valeur NULL.

Notes

Vous devez appeler RegisterForReport avant d’appeler cette méthode.

Exemples

L’exemple suivant montre comment appeler GetReportInterval.


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

Spécifications

   
Client minimal pris en charge Windows 7 [applications de bureau uniquement],Windows 7
Serveur minimal pris en charge Aucun pris en charge
Plateforme cible Windows
En-tête locationapi.h
DLL LocationAPI.dll

Voir aussi

ILocation