IDirectPlay8Address::IsEqual Method

Compares two addresses to see if they are equal.

Syntax

HRESULT IsEqual(      
    PDIRECTPLAY8ADDRESS pdpaAddress
);

Parameters

pdpaAddress

[in] Address to compare to the address contained within the object.

Return Value

If the addresses are equal DPNSUCCESS_EQUAL is returned. If the addresses are not equal DPNSUCCESS_NOTEQUAL is returned.

If the method fails, one of the following error values may be returned.

DPNERR_INVALIDADDRESSFORMAT	The address format is invalid.
DPNERR_INVALIDOBJECT	The Microsoft® DirectPlay® object pointer is invalid.
DPNERR_INVALIDPOINTER	Pointer specified as a parameter is invalid.

Remarks

This method checks the contents of the address specified by the pdpaAddress parameter and compares it to the address contained within the object this method was called on. This method does not affect the contents of either address.