docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct InputUserAccountHandle

    Handle for a user account in an external API.

    Implements
    IEquatable<InputUserAccountHandle>
    Namespace: UnityEngine.InputSystem.Users
    Assembly: Unity.InputSystem.dll
    Syntax
    public struct InputUserAccountHandle : IEquatable<InputUserAccountHandle>

    Constructors

    InputUserAccountHandle(string, ulong)

    Declaration
    public InputUserAccountHandle(string apiName, ulong handle)
    Parameters
    Type Name Description
    string apiName
    ulong handle

    Properties

    apiName

    Symbolic name of the API that owns the handle.

    Declaration
    public string apiName { get; }
    Property Value
    Type Description
    string
    Remarks

    This essentially provides a namespace for handle.

    On PS4, for example, this will read "PS4" for user handles corresponding to sceUserId.

    This will not be null or empty except if the handle is invalid.

    handle

    Declaration
    public ulong handle { get; }
    Property Value
    Type Description
    ulong

    Methods

    Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    ValueType.Equals(object)

    Equals(InputUserAccountHandle)

    Declaration
    public bool Equals(InputUserAccountHandle other)
    Parameters
    Type Name Description
    InputUserAccountHandle other
    Returns
    Type Description
    bool

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    ValueType.GetHashCode()

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    ValueType.ToString()

    Operators

    operator ==(InputUserAccountHandle, InputUserAccountHandle)

    Declaration
    public static bool operator ==(InputUserAccountHandle left, InputUserAccountHandle right)
    Parameters
    Type Name Description
    InputUserAccountHandle left
    InputUserAccountHandle right
    Returns
    Type Description
    bool

    operator !=(InputUserAccountHandle, InputUserAccountHandle)

    Declaration
    public static bool operator !=(InputUserAccountHandle left, InputUserAccountHandle right)
    Parameters
    Type Name Description
    InputUserAccountHandle left
    InputUserAccountHandle right
    Returns
    Type Description
    bool

    Implements

    IEquatable<T>
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)