PLUGIN_STATE

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

• Windows Embedded CE 6.0 R3

8/28/2008

This enumeration defines the possible values for the current state of a plugin DLL.

Syntax

namespace LocationFramework {
typedef enum {
    PLUGIN_STATE_NOT_SUPPORTED
    PLUGIN_STATE_ERROR
    PLUGIN_STATE_OFF
    PLUGIN_STATE_SHUTTING_DOWN
    PLUGIN_STATE_UNAVAILABLE
    PLUGIN_STATE_STARTING_UP
    PLUGIN_STATE_ON
} PLUGIN_STATE;
}

Elements

• PLUGIN_STATE_NOT_SUPPORTED
  There is no plugin on the system that can generate the report type. This value is returned when LocationGetPluginInfoForReport is called with a non-supported report-type.

• PLUGIN_STATE_ERROR
  The plugin has entered a fatal state, either as the result of crashing or performing some other illegal operation. Once a plugin enters the error state, it cannot leave it until the location service is restarted or the system is rebooted.

• PLUGIN_STATE_OFF
  No applications have requested reports that this plugin can generate.

• PLUGIN_STATE_SHUTTING_DOWN
  The last application using a plugin has unregistered for it and the plugin has been alerted to stop, but the plugin has not completely stopped itself yet.

• PLUGIN_STATE_UNAVAILABLE
  The plugin has been requested to retrieve reports but is unable to. This can be the result of a temporary position, such as a GPS device not working indoors, or a condition that will not automatically self-correct (such as invalid credentials being supplied to a plugin).

• PLUGIN_STATE_STARTING_UP
  The plugin has been requested to retrieve reports and is in the process of retrieving its first one.

• PLUGIN_STATE_ON
  The plugin has successfully generated at least one report and has indicated to Location Framework that it can continue to generate new ones, based on its internal polling intervals.

Requirements

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

See Also

Other Resources

Location Framework Enumerations