Share via


XboxLiveDeviceAddress.Compare(XboxLiveDeviceAddress) Method

Definition

Compares another XboxLiveDeviceAddress object to the current object, to see whether they represent the same device.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public:
 virtual int Compare(XboxLiveDeviceAddress ^ otherDeviceAddress) = Compare;
int Compare(XboxLiveDeviceAddress const& otherDeviceAddress);
public int Compare(XboxLiveDeviceAddress otherDeviceAddress);
function compare(otherDeviceAddress)
Public Function Compare (otherDeviceAddress As XboxLiveDeviceAddress) As Integer

Parameters

otherDeviceAddress
XboxLiveDeviceAddress

The XboxLiveDeviceAddress to be compared to this one.

Returns

Int32

int

Zero if the two objects represent the same device; non-zero if they represent different devices

Remarks

This method compares the invoking object (this) with the given XboxLiveDeviceAddress object, and returns a value you can use to sort XboxLiveDeviceAddress objects. A.Compare(B) returns 0 if A and B refer to the same device. If they don't refer to the same device, then if A.Compare(B) returns -1, B.Compare(A) returns +1. The returned value can thus be used to consistently sort one XboxLiveDeviceAddress relative to another.

No connection to either of the XboxLiveDeviceAddress objects involved is required; and this method doesn't initiate communication with them.

Applies to