IPXC_CState::Compare Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Compares two '''IPXC_CState''' objects. Objects that belong to different documents are never equal. | |
== Syntax == | == Syntax == | ||
| Line 13: | Line 13: | ||
== Parameters == | == Parameters == | ||
;pState | ;pState | ||
| − | :[in] | + | :[in] The [[PXV:IPXC_CState|IPXC_CState]] object to compare. |
;pResult | ;pResult | ||
| − | :[out, retval] | + | :[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 == | == Return Value == | ||
Revision as of 14:46, 27 April 2015
Compares two IPXC_CState objects. Objects that belong to different documents are never equal.
Contents
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.
