SRestriction

SRestriction

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

This page is specific to

The 2007 product release

Other versions are also available for the following:

The 2010 product release

SRestriction

Describes a filter for limiting the view of a table to particular rows.

Header file:

Mapidefs.h

C++

typedef struct _SRestriction
{
  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: An AND restriction, which applies a bitwise AND operation to a restriction.

RES_BITMASK: A bitmask restriction, which applies a bitmask to a property value.

RES_COMMENT: A comment restriction, which associates a comment with a restriction.

RES_COMPAREPROPS: A property comparison restriction, which compares two property values.

RES_CONTENT: A content restriction, which searches a property value for specific content.

RES_EXIST: An exist restriction, which determines whether a property is supported.

RES_NOT: A NOT restriction, which applies a logical NOT operation to a restriction.

RES_OR: An OR restriction, which applies a logical OR operation to a restriction.

RES_PROPERTY: A property restriction, which determines whether a property value matches a particular value.

RES_SIZE: A size restriction, which determines whether a property value is a particular size.

RES_SUBRESTRICTION: 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 the res member depends on the value of the rt member. 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 either IMAPITable::Restrict or IMAPITable::FindRow. To impose the limitation on a folder, clients call the folder's IMAPIContainer::SetSearchCriteria method.

For information about how to use restrictions with tables, see About Restrictions.

Reference

SAndRestriction
SBitMaskRestriction
SCommentRestriction
SComparePropsRestriction
SContentRestriction
SExistRestriction
SNotRestriction
SOrRestriction
SPropertyRestriction
SSizeRestriction
SSubRestriction

Concepts

MAPI Structures