SRestriction

4/8/2010

The SRestriction structure describes a filter for limiting the view of a table to particular rows.

Syntax

struct {
   ULONG rt;
      Union {
     SComparePropsRestriction  resCompareProps;
     SAndRestriction           resAnd;
     SOrRestriction            resOr;
     SNotRestriction           resNot;
     SContentRestriction       resContent;
     SPropertyRestriction      resProperty;
     SBitMaskRestriction       resBitMask;
     SSizeRestriction          resSize;
     SExistRestriction         resExist;
     SSubRestriction           resSub;
     SCommentRestriction       resComment;
   } res;
} SRestriction;

Members

• rt
  The restriction type. Possible values are as follows:

  • RES_AND
    Describes an AND restriction, which applies a bitwise AND operation to a restriction.
  • RES_BITMASK
    Describes a bitmask restriction, which applies a bitmask to a property value.
  • RES_COMMENT
    Describes a comment restriction, which associates a comment with a restriction.
  • RES_COMPAREPROPS
    Describes a compare properties restriction, which compares two property values.
  • RES_CONTENT
    Describes a content restriction, which searches a property value for specific content.
  • RES_EXIST
    Describes an existence restriction, which determines if a property is supported.
  • RES_NOT
    Describes a NOT restriction, which applies a logical NOT operation to a restriction.
  • RES_OR
    Describes an OR restriction, which applies a logical OR operation to a restriction.
  • RES_PROPERTY
    Describes a property restriction, which determines whether a property value matches a particular value.
  • RES_SIZE
    Describes a size restriction, which determines whether a property value is a particular size.
  • RES_SUBRESTRICTION
    Describes a sub object restriction, which applies a restriction to a message's attachments or recipients.

• res
  Union of restriction structures describing the filter to be applied. The specific structure included in res depends on the value of rt. The mapping between restriction type and structure is listed in the following table.

  Restriction type	Restriction structure
  RES_AND	SAndRestriction
  RES_BITMASK	SBitMaskRestriction
  RES_COMMENT	SCommentRestriction
  RES_COMPAREPROPS	SComparePropsRestriction
  RES_CONTENT	SContentRestriction
  RES_EXIST	SExistRestriction
  RES_NOT	SNotRestriction
  RES_OR	SOrRestriction
  RES_PROPERTY	SPropertyRestriction
  RES_SIZE	SSizeRestriction
  RES_SUBRESTRICTION	SSubRestriction

Remarks

Clients use an SRestriction structure to limit the number and type of rows in their view of a table and to search for specific messages in a folder. To impose the limitation on a table, clients call IMAPITable::Restrict.

Requirements

Header	mapidefs.h
Windows Embedded CE	Windows CE 3.0 and later
Windows Mobile	Pocket PC 2002 and later, Smartphone 2002 and later

See Also

Reference

IMAPITable::Restrict
MAPI Structures
SAndRestriction
SBitMaskRestriction
SCommentRestriction
SComparePropsRestriction
SContentRestriction
SExistRestriction
SNotRestriction
SOrRestriction
SPropertyRestriction
SSizeRestriction
SSubRestriction

Other Resources

Messaging