SSubRestriction

The SSubRestriction structure describes a subobject restriction which is used to filter the rows of a message's attachment or recipient table.

Quick Info

Header file:

MAPIDEFS.H

typedef struct _SSubRestriction 
{ 
     ULONG          ulSubObject; 
     LPSRestriction lpRes; 
} SSubRestriction;

Members

ulSubObject

Type of subobject to serve as the target for the restriction. Possible values are:

PR_MESSAGE_RECIPIENTS: Apply the restriction to a message's recipient table.
PR_MESSAGE_ATTACHMENTS: Apply the restriction to a message's attachment table.

lpRes

Pointer to an SRestriction structure.

Remarks

Subobject restrictions are not supported by all tables. Typically, only folder contents tables and search-results folders support them. Subobject restrictions are used, for example, to find a message that has a particular type of attachment or recipient.

If an implementation does not support subobject restrictions, it returns MAPI_E_TOO_COMPLEX from its IMAPITable::Restrict or IMAPITable::FindRow methods.

For a general discussion of how restrictions work, see About Restrictions.