ProviderGetLocation
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
A Provider DLL implements this function. The Location Framework calls this export when it needs reports that this Provider can generate.
Syntax
DWORD ProviderGetLocation(
PROVIDER_CONTROL_BLOCK* pProvControlBlock
);
Parameters
- pProvControlBlock
Pointer to a PROVIDER_CONTROL_BLOCK, which contains information about the current request for the device’s position.
Return Value
If the Provider returns any value other than ERROR_SUCCESS, the Location Framework will assume that a fatal error has occurred and will cause the plugin to go into the PLUGIN_STATE_ERROR state. If a Provider returns before it has been requested to via a ProviderStop, the Location Framework will treat this as an illegal operation and put the plugin into the PLUGIN_STATE_ERROR state.
Remarks
ProviderGetLocation is called whenever the Location Framework determines that a report that this Provider can generate is required. This can be the result of an application requiring the report directly or alternately a Resolver needing the report to resolve into another type. The Provider is abstracted from the final use of its report and should generate reports as always based on this configuration.
Requirements
| Header | lfplugin.h |
| Windows Embedded CE | Windows Embedded CE 6.0 and later |