Share via


PLUGIN_INFORMATION

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

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This structure defines the basic information of a particular plugin. This information is basic to both Providers and Resolvers.

Syntax

typedef struct _PLUGIN_INFORMATION {
    DWORD         version;
    GUID          guid;
    WCHAR         friendlyName[MAX_PLUGIN_FRIENDLY_NAME];
    PLUGIN_STATE  pluginState;
    DWORD         retryInterval;
    DWORD         maximumInitialWait;
    DWORD         numReportsGenerated;
    GUID          reportsGenerated[MAX_PLUGIN_REPORT_TYPES];
    FILETIME      lastUpdate;
    DWORD         pluginFlags;
} PLUGIN_INFORMATION, *PPLUGIN_INFORMATION;

Members

  • version
    Version of the plugin DLL.
  • guid
    GUID representing the plugin DLL.
  • friendlyName
    Friendly name of the plugin DLL, such as "Microsoft GPS Provider".
  • pluginState
    Current state the plugin is in.
  • retryInterval
    Time, in milliseconds, a plugin waits before attempting to restart if it encounters a failure and enters the PLUGIN_STATE_UNAVAILABLE.
  • maximumInitialWait
    Time, in milliseconds, within which a plugin must determine its first position on startup or else it will fail and enter the PLUGIN_STATE_UNAVAILABLE.
  • numReportsGenerated
    The number of reports this plugin can generate.
  • reportsGenerated
    Array of GUIDs indicate the reports this plugin can generate.
  • lastUpdate
    Time, specified as FILETIME, when plugin generated last report. Note on most systems this is only accurate to within 1000ms.
  • pluginFlags
    Plugin flags with extra configuration options for the particular plugin. These are unique per plugin and are not defined globally.

Requirements

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

See Also

Reference

Location Framework Structures