FPropCompareProp

The FPropCompareProp function compares two property values using a binary relational operator.

Note This function may not be supported in future versions of MAPI.

Quick Info

Header file:	MAPIUTIL.H
Implemented by:	MAPI
Called by:	Client applications and service providers

BOOL FPropCompareProp(
  LPSPropValue lpSPropValue1,   
  ULONG ulRelOp,              
  LPSPropValue lpSPropValue2  
);

Parameters

lpSPropValue1: [in] Pointer to an SPropValue structure defining the first property value for comparison.
ulRelOp: [in] The relational operator to use in the comparison.
lpSPropValue2: [in] Pointer to an SPropValue structure defining the second property value for comparison.

Return Values

TRUE: The property values satisfy the specified relation.
FALSE: The property values do not satisfy the specified relation.

Remarks

The comparison method depends on the property types specified in the SPropValue property definitions. The FPropCompareProp and FPropContainsProp functions can be used to prepare restrictions for generating a table.

The order of comparison is lpSPropValue1, ulRelOp, lpSPropValue2. If the property types of the property values to be compared do not match, the FPropCompareProp function returns FALSE. For allowable values for ulRelOp and for more information on property comparison, see the SComparePropsRestriction structure.