MagnetometerReading Class

Definition

Namespace:

Windows.Devices.Sensors

Represents a magnetometer reading.

public ref class MagnetometerReading sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class MagnetometerReading final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class MagnetometerReading

Public NotInheritable Class MagnetometerReading

Inheritance

Object Platform::Object IInspectable MagnetometerReading

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

This object is accessed when you invoke the GetCurrentReading method; and, it is accessed when you retrieve the Reading property of the MagnetometerReadingChangedEventArgs object in the event callback method.

Version history

Windows version	SDK version	Value added
1709	16299	PerformanceCount
1709	16299	Properties

Properties

DirectionalAccuracy	Gets the magnetometer's directional accuracy.
MagneticFieldX	Gets the magnetic field strength in microteslas along the X axis.
MagneticFieldY	Gets the magnetic field strength in microteslas along the Y axis.
MagneticFieldZ	Gets the magnetic field strength in microteslas along the Z axis.
PerformanceCount	Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.
Properties	Gets the data properties reported by the sensor.
Timestamp	Gets the time at which the sensor reported the reading.