FPropCompareProp

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Compares two property values using a specified relational operator.

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. For allowable values, see the SComparePropsRestriction structure.

  • lpSPropValue2
    [in] Pointer to an SPropValue structure defining the second property value for comparison.

Return Value

  • 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.