Méthode ILocation::SetReportInterval (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 . ]
Spécifie la durée minimale demandée, en millisecondes, entre les événements de rapport.
Syntaxe
HRESULT SetReportInterval(
[in] REFIID reportType,
[in] DWORD millisecondsRequested
);
Paramètres
[in] reportType
REFIID qui spécifie le type de rapport pour lequel définir l’intervalle.
[in] millisecondsRequested
DWORD qui contient la valeur d’intervalle de rapport, en millisecondes. Si cette valeur est égale à 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 |
|
L’appelant n’est pas inscrit pour recevoir des événements pour le type de rapport spécifié. |
|
reportType n’était pas IID_ILatLongReport ou IID_ICivicAddressReport. |
Notes
L’intervalle que vous demandez à l’aide de cette méthode représente la durée la plus courte entre les événements. Cela signifie que vous demandez à recevoir des notifications d’événements pas plus fréquemment que spécifié, mais que le temps écoulé peut être considérablement plus long. Utilisez cette méthode pour vous assurer que les notifications d’événements n’utilisent pas plus de ressources de processeur que nécessaire.
Il n’est pas garanti que votre demande pour un intervalle de rapport particulier soit définie par le fournisseur d’emplacement. Appelez GetReportInterval pour découvrir le paramètre d’intervalle de rapport réel.
Un intervalle de rapport de zéro signifie qu’aucun intervalle minimal n’est spécifié et que l’application peut recevoir des événements à la fréquence que le capteur d’emplacement envoie des événements.
Exemples
L’exemple suivant montre comment appeler SetReportInterval.
// Set the latitude/longitude report interval to 1000 milliseconds
HRESULT hr = spLocation->SetReportInterval(IID_ILatLongReport, 1000);
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 |