Struct HSteamPipe

Wraps the Steamworks HSteamPipe handle, a int.

Implements

IEquatable<HSteamPipe>

IComparable<HSteamPipe>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

[Serializable]
public struct HSteamPipe : IEquatable<HSteamPipe>, IComparable<HSteamPipe>

Constructors

HSteamPipe(int)

Initializes a new HSteamPipe from its underlying value.

Declaration

public HSteamPipe(int value)

Parameters

Type	Name	Description
int	value	The underlying int value.

Fields

m_HSteamPipe

The underlying int value.

Declaration

public int m_HSteamPipe

Field Value

Type	Description
int

Methods

CompareTo(HSteamPipe)

Orders this value against other by their underlying values.

Declaration

public int CompareTo(HSteamPipe other)

Parameters

Type	Name	Description
HSteamPipe	other	The value to compare against.

Returns

Type	Description
int	Negative, zero or positive as this value sorts before, with or after other.

Equals(object)

Returns true when other is a HSteamPipe with the same value.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other	The object to compare against.

Returns

Type	Description
bool	true when other is a HSteamPipe holding the same value.

Overrides

ValueType.Equals(object)

Equals(HSteamPipe)

Returns true when this value equals other.

Declaration

public bool Equals(HSteamPipe other)

Parameters

Type	Name	Description
HSteamPipe	other	The value to compare against.

Returns

Type	Description
bool	true when both hold the same underlying value.

GetHashCode()

Returns the hash code of the underlying value.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The underlying value's hash code.

Overrides

ValueType.GetHashCode()

ToString()

Returns the underlying value as a string.

Declaration

public override string ToString()

Returns

Type	Description
string	The underlying value formatted by its own ToString.

Overrides

ValueType.ToString()

Operators

operator ==(HSteamPipe, HSteamPipe)

Returns true when both operands hold the same value.

Declaration

public static bool operator ==(HSteamPipe x, HSteamPipe y)

Parameters

Type	Name	Description
HSteamPipe	x	The first value to compare.
HSteamPipe	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold the same underlying value.

explicit operator HSteamPipe(int)

Converts a int to a HSteamPipe. Explicit, so two handle types cannot convert into each other through the type they share.

Declaration

public static explicit operator HSteamPipe(int value)

Parameters

Type	Name	Description
int	value	The underlying int value.

Returns

Type	Description
HSteamPipe	A HSteamPipe holding value.

explicit operator int(HSteamPipe)

Converts a HSteamPipe to its underlying int.

Declaration

public static explicit operator int(HSteamPipe that)

Parameters

Type	Name	Description
HSteamPipe	that	The handle to unwrap.

Returns

Type	Description
int	The underlying int value.

operator !=(HSteamPipe, HSteamPipe)

Returns true when the operands hold different values.

Declaration

public static bool operator !=(HSteamPipe x, HSteamPipe y)

Parameters

Type	Name	Description
HSteamPipe	x	The first value to compare.
HSteamPipe	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold different underlying values.

Implements

IEquatable<T>

IComparable<T>