LocationPluginIOCTL

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

• Windows Embedded CE 6.0 R3

8/28/2008

This function sends an IOCTL to the specified plugin DLL.

Syntax

DWORD LocationPluginIOCTL(
        HLOCATION       hLocation,
        HLOCATIONPLUGIN hPlugin,
        DWORD           dwCode,
        BYTE*           pbIn,
        DWORD           cbIn,
        BYTE*           pbOut,
        DWORD*          pcbOut
);

Parameters

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

• hPlugin
  A handle to the plugin returned from a call to LocationPluginOpen.

• dwCode
  IOCTL for this operation. The Location Framework defines a set of common IOCTLs that plugins may implement for consistency, but does not mandate any IOCTL to be implemented. Plugins may also implement their own custom IOCTL codes.

• pbIn
  Pointer to a buffer that contains the data required to perform the operation.

• cbIn
  Size, in bytes, of the buffer pointed to by pbIn.

• pbOut
  Pointer to a buffer that receives the output data for the operation.

• pcbOut
  On input, specifies the length of pcbOut. On output, indicates the number of bytes the plugin has written to pcbOut.

Return Value

If successful, returns ERROR_SUCCESS.

If unsuccessful, returns an error code.

Requirements

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

See Also

Reference

Location Framework Functions
LocationOpen
LocationPluginOpen