PROVIDER_CONTROL_BLOCK

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

The Location Framework passes a PROVIDER_CONTROL_BLOCK to a Provider during its call to ProviderGetLocation. This block contains information such as how long the Provider should wait between retries on failure and polling intervals as well as callback functions to the Location Framework itself.

Syntax

typedef struct _PROVIDER_CONTROL_BLOCK {
    DWORD                 version;
    HANDLE                provContext;
    PROVIDER_INFORMATION* pProvInfo;
    DWORD (WINAPI* NewProviderReport)(HANDLE provContext, LOCATION_REPORT* pNewReport);
    DWORD (WINAPI* ProviderUnavailable)(HANDLE provContext);
} PROVIDER_CONTROL_BLOCK, *PPROVIDER_CONTROL_BLOCK;

Members

• version
  The version of the Location Framework making this call. This value will always be the value of LOCATION_FRAMEWORK_VERSION_CURRENT that the version of Location Framework on the system was created under.

• provContext
  This contains a context value indicating the Provider itself. The Provider when calling back into the Location Framework must use this provContext.

• pProvInfo
  This is a pointer to a PROVIDER_INFORMATION structure that contains configuration information about the plugin. The Location Framework only reads in information such as poll interval from the registry; it is the Provider’s responsibility to actually honor these configuration settings.

• NewProviderReport
  Indicates the callback function that the Provider calls when a new report is available.

• ProviderUnavailable
  Indicates the callback function that the Provider calls when it can no longer generate a report.

Requirements

Header	lfplugin.h
Windows Embedded CE	Windows Embedded CE 6.0 and later

See Also

Reference

Location Framework Plugin Structures
PROVIDER_INFORMATION
ProviderGetLocation