Struct InputUserAccountHandle

Handle for a user account in an external API.

Namespace: UnityEngine.InputSystem.Plugins.Users
Syntax
public struct InputUserAccountHandle : IEquatable<InputUserAccountHandle>

Constructors

InputUserAccountHandle(String, UInt64)

Declaration
public InputUserAccountHandle(string apiName, ulong handle)
Parameters
Type Name Description
System.String apiName
System.UInt64 handle

Properties

apiName

Symbolic name of the API that owns the handle.

Declaration
public string apiName { get; }
Property Value
Type Description
System.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
System.UInt64

Methods

Equals(Object)

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

Equals(InputUserAccountHandle)

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

GetHashCode()

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

ToString()

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

Operators

Equality(InputUserAccountHandle, InputUserAccountHandle)

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

Inequality(InputUserAccountHandle, InputUserAccountHandle)

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