Struct HServerQuery

Wraps the Steamworks HServerQuery handle, a int.

Implements

IEquatable<HServerQuery>

IComparable<HServerQuery>

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 HServerQuery : IEquatable<HServerQuery>, IComparable<HServerQuery>

Constructors

HServerQuery(int)

Initializes a new HServerQuery from its underlying value.

Declaration

public HServerQuery(int value)

Parameters

Type	Name	Description
int	value	The underlying int value.

Fields

Invalid

The value the SDK reserves to mean "no HServerQuery".

Declaration

public static readonly HServerQuery Invalid

Field Value

Type	Description
HServerQuery

m_HServerQuery

The underlying int value.

Declaration

public int m_HServerQuery

Field Value

Type	Description
int

Methods

CompareTo(HServerQuery)

Orders this value against other by their underlying values.

Declaration

public int CompareTo(HServerQuery other)

Parameters

Type	Name	Description
HServerQuery	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 HServerQuery 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 HServerQuery holding the same value.

Overrides

ValueType.Equals(object)

Equals(HServerQuery)

Returns true when this value equals other.

Declaration

public bool Equals(HServerQuery other)

Parameters

Type	Name	Description
HServerQuery	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 ==(HServerQuery, HServerQuery)

Returns true when both operands hold the same value.

Declaration

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

Parameters

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

Returns

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

explicit operator HServerQuery(int)

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

Declaration

public static explicit operator HServerQuery(int value)

Parameters

Type	Name	Description
int	value	The underlying int value.

Returns

Type	Description
HServerQuery	A HServerQuery holding value.

explicit operator int(HServerQuery)

Converts a HServerQuery to its underlying int.

Declaration

public static explicit operator int(HServerQuery that)

Parameters

Type	Name	Description
HServerQuery	that	The handle to unwrap.

Returns

Type	Description
int	The underlying int value.

operator !=(HServerQuery, HServerQuery)

Returns true when the operands hold different values.

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>

IComparable<T>