LocationOpen
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This function initializes the use of the Location Framework functions.
Syntax
HLOCATION LocationOpen(
DWORD version,
VOID* pReserved,
DWORD flags
);
Parameters
- version
Version of Location Framework implementation to interface with. The latest version will always be LOCATION_FRAMEWORK_VERSION_CURRENT. Currently this value must be LOCATION_FRAMEWORK_VERSION_1 (1).
- pReserved
Reserved. Must be NULL.
- flags
Reserved. Must be 0.
Return Value
If successful, returns a handle to the Location Framework.
If unsuccessful, returns NULL.
Remarks
This call is only used to initialize an applications use of Location Framework. It will not cause the state of any underlying plugin DLLs to change. If a platform implements a security system that restricts application access to location information, an application without such privilege would fail on this call. A platform could also potentially implement a security system whereby a user was prompted for permission to allow the given application to access location information, in which case it would most likely be triggered by an application making this call.
Requirements
| Header | lfapi.h |
| Library | lfapi.lib |
| Windows Embedded CE | Windows Embedded CE 6.0 and later |