LocationGetPluginInfoForReport

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

• Windows Embedded CE 6.0 R3

8/28/2008

For a given report type, retrieve information about the particular plugin (if one exists) that is currently generating reports of that type.

Syntax

DWORD LocationGetPluginInfoForReport(
    HLOCATION     hLocation,
    REFGUID       reportType, 
    PLUGIN_STATE* pPluginState,
    GUID*         pPluginGuid
);

Parameters

• hLocation
  A handle to the Location Framework returned from a call to LocationOpen.

• reportType
  GUID specifying the report type that the associated plugin should be queried for.

• pPluginState
  Pointer to a PLUGIN_STATE buffer to retrieve the current state of the plugin.

• pPluginGuid
  (Optional) Pointer to a GUID that will contain the GUID of the plugin that is generating the report.

Return Value

If successful, returns ERROR_SUCCESS.

If unsuccessful, returns an error code.

Remarks

The Location Framework attempts to start up lower priority plugins if a preferred plugin fails. In the case where there are multiple plugins that can generate the same report, the one in the “highest” state will be returned to the application. In this situation, the highest state will be based on the numerical values of the PLUGIN_STATE enumeration. For instance, if a higher priority plugin is in PLUGIN_STATE_UNAVAILABLE and a lower priority plugin is in PLUGIN_STATE_ON, the application would receive PLUGIN_STATE_ON and a pointer to the lower priority plugin because this is the most relevant plugin with regards to the current state of generating reports.

Requirements

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

See Also

Reference

Location Framework Functions
LocationOpen