IPXC_CState::Compare Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 17: Line 17:
 
:[out, retval] Pointer to '''LONG''' variant that will get result of comparison. If objects are equal it will be '''0''' (zero). Otherwise, it will be '''-1''' or '''1'''. The result is useful for ordering '''IPXC_CState''' objects.
 
:[out, retval] Pointer to '''LONG''' variant that will get result of comparison. If objects are equal it will be '''0''' (zero). Otherwise, it will be '''-1''' or '''1'''. The result is useful for ordering '''IPXC_CState''' objects.
 
: The following conditions apply:
 
: The following conditions apply:
:: If a.Compare(b) == 0, then b.Compare(a) == 0.
+
:* If a.Compare(b) == 0, then b.Compare(a) == 0.
:: If a.Compare(b) > 0, then b.Compare(a) < 0.
+
:* If a.Compare(b) > 0, then b.Compare(a) < 0.
:: If a.Compare(b) < 0, then b.Compare(a) > 0.
+
:* If a.Compare(b) < 0, then b.Compare(a) > 0.
:: If a.Compare(b) == 0, and b.Compare(c) == 0, then a.Compare(c) == 0.
+
:* If a.Compare(b) == 0, and b.Compare(c) == 0, then a.Compare(c) == 0.
:: If a.Compare(b) > 0, and b.Compare(c) > 0, then a.Compare(c) > 0.
+
:* If a.Compare(b) > 0, and b.Compare(c) > 0, then a.Compare(c) > 0.
:: If a.Compare(b) < 0, and b.Compare(c) < 0, then a.Compare(c) < 0.
+
:* If a.Compare(b) < 0, and b.Compare(c) < 0, then a.Compare(c) < 0.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 15:52, 27 April 2015


Compares two IPXC_CState objects. Objects that belong to different documents are never equal.

Syntax

HRESULT Compare([in]           IPXC_CState*  pState,
                [out, retval]  LONG*         pResult);

Parameters

pState
[in] The IPXC_CState object to compare.
pResult
[out, retval] Pointer to LONG variant that will get result of comparison. If objects are equal it will be 0 (zero). Otherwise, it will be -1 or 1. The result is useful for ordering IPXC_CState objects.
The following conditions apply:
  • If a.Compare(b) == 0, then b.Compare(a) == 0.
  • If a.Compare(b) > 0, then b.Compare(a) < 0.
  • If a.Compare(b) < 0, then b.Compare(a) > 0.
  • If a.Compare(b) == 0, and b.Compare(c) == 0, then a.Compare(c) == 0.
  • If a.Compare(b) > 0, and b.Compare(c) > 0, then a.Compare(c) > 0.
  • If a.Compare(b) < 0, and b.Compare(c) < 0, then a.Compare(c) < 0.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXC_CState.