Compass.GetCurrentReading Method

Gets the current compass reading.

Syntax

public:
CompassReading^ GetCurrentReading()  

Return value

Type: CompassReading 

The current compass reading.

Remarks

An application may use this method to poll the sensor for the current reading as an alternative to registering a ReadingChanged event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired ReportInterval. This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests.

The returned value is a magnetic heading specified in degrees.

The accuracy of this value is dependent on the capabilities of the compass.

Before using the return value from this method, the application must first check that the value is not null.

Requirements

Namespace: Windows.Devices.Sensors

Metadata: windows.winmd

See also

Reference

Compass Class

Compass Members

Windows.Devices.Sensors Namespace