mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class WindowsApiChecker

    Helper class for determining if a Windows API contract is available.

    Inheritance
    Object
    WindowsApiChecker
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Windows.Utilities
    Assembly: cs.temp.dll.dll
    Syntax
    public static class WindowsApiChecker
    Remarks

    See https://docs.microsoft.com/uwp/extension-sdks/windows-universal-sdk for a full list of contracts.

    Properties

    UniversalApiContractV3_IsAvailable

    Is the Universal API Contract v3.0 Available?

    Declaration
    public static bool UniversalApiContractV3_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV3_IsAvailable

    Is the Universal API Contract v3.0 Available?

    Declaration
    public static bool UniversalApiContractV3_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV4_IsAvailable

    Is the Universal API Contract v4.0 Available?

    Declaration
    public static bool UniversalApiContractV4_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV4_IsAvailable

    Is the Universal API Contract v4.0 Available?

    Declaration
    public static bool UniversalApiContractV4_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV5_IsAvailable

    Is the Universal API Contract v5.0 Available?

    Declaration
    public static bool UniversalApiContractV5_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV5_IsAvailable

    Is the Universal API Contract v5.0 Available?

    Declaration
    public static bool UniversalApiContractV5_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV6_IsAvailable

    Is the Universal API Contract v6.0 Available?

    Declaration
    public static bool UniversalApiContractV6_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV6_IsAvailable

    Is the Universal API Contract v6.0 Available?

    Declaration
    public static bool UniversalApiContractV6_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV7_IsAvailable

    Is the Universal API Contract v7.0 Available?

    Declaration
    public static bool UniversalApiContractV7_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV7_IsAvailable

    Is the Universal API Contract v7.0 Available?

    Declaration
    public static bool UniversalApiContractV7_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV8_IsAvailable

    Is the Universal API Contract v8.0 Available?

    Declaration
    public static bool UniversalApiContractV8_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    UniversalApiContractV8_IsAvailable

    Is the Universal API Contract v8.0 Available?

    Declaration
    public static bool UniversalApiContractV8_IsAvailable { get; }
    Property Value
    Type Description
    Boolean

    Methods

    CheckApiContracts()

    Declaration
    public static void CheckApiContracts()

    CheckApiContracts()

    Declaration
    public static void CheckApiContracts()

    IsMethodAvailable(String, String, String)

    Checks to see if the requested method is present on the current platform.

    Declaration
    public static bool IsMethodAvailable(string namespaceName, string className, string methodName)
    Parameters
    Type Name Description
    String namespaceName

    The namespace (ex: "Windows.UI.Input.Spatial") containing the class.

    String className

    The name of the class containing the method (ex: "SpatialInteractionMananger").

    String methodName

    The name of the method (ex: "IsSourceKindSupported").

    Returns
    Type Description
    Boolean

    True if the method is available and can be called. Otherwise, false.

    IsPropertyAvailable(String, String, String)

    Checks to see if the requested property is present on the current platform.

    Declaration
    public static bool IsPropertyAvailable(string namespaceName, string className, string propertyName)
    Parameters
    Type Name Description
    String namespaceName

    The namespace (ex: "Windows.UI.Input.Spatial") containing the class.

    String className

    The name of the class containing the method (ex: "SpatialPointerPose").

    String propertyName

    The name of the method (ex: "Eyes").

    Returns
    Type Description
    Boolean

    True if the property is available and can be called. Otherwise, false.

    IsTypeAvailable(String, String)

    Checks to see if the requested type is present on the current platform.

    Declaration
    public static bool IsTypeAvailable(string namespaceName, string typeName)
    Parameters
    Type Name Description
    String namespaceName

    The namespace (ex: "Windows.UI.Input.Spatial") containing the class.

    String typeName

    The name of the class containing the method (ex: "SpatialPointerPose").

    Returns
    Type Description
    Boolean

    True if the type is available and can be called. Otherwise, false.

    In This Article
    • Properties
      • UniversalApiContractV3_IsAvailable
      • UniversalApiContractV3_IsAvailable
      • UniversalApiContractV4_IsAvailable
      • UniversalApiContractV4_IsAvailable
      • UniversalApiContractV5_IsAvailable
      • UniversalApiContractV5_IsAvailable
      • UniversalApiContractV6_IsAvailable
      • UniversalApiContractV6_IsAvailable
      • UniversalApiContractV7_IsAvailable
      • UniversalApiContractV7_IsAvailable
      • UniversalApiContractV8_IsAvailable
      • UniversalApiContractV8_IsAvailable
    • Methods
      • CheckApiContracts()
      • CheckApiContracts()
      • IsMethodAvailable(String, String, String)
      • IsPropertyAvailable(String, String, String)
      • IsTypeAvailable(String, String)
    Back to top Generated by DocFX