Fields Property (MessageFilter Object)
Fields Property (MessageFilter Object)
The Fields property returns a single Field object or a Fields collection object. Read-only.
Syntax
objMessageFilter.Fields
objMessageFilter.Fields(index)
objMessageFilter.Fields(proptag)
objMessageFilter.Fields(name)
index
Integer. Value must be greater than 0 and less than or equal to 65,535 (&HFFFF). Specifies the index within the Fields collection.
proptag
Long. Value must be greater than or equal to 65,536 (&H10000). Specifies the property tag value for the MAPI property to be retrieved.
name
String. Specifies the name of the custom MAPI property.
Data Type
Object (Field or Fields collection)
Remarks
The Fields property returns one or all of the fields associated with a MessageFilter object. Each field typically corresponds to a MAPI property. Data types are preserved, except that MAPI counted binary properties are converted to and from character strings representing hexadecimal digits.
The fields that have been set in the Fields collection specify the filter, together with any other MessageFilter properties that have been set.
The Fields property provides a generic access mechanism that allows Microsoft® Visual Basic® and Microsoft® Visual C++® programmers to retrieve the value of a MAPI property using either its name or its MAPI property tag. For access with the property tag, use objMessageFilter.Fields(proptag), where proptag is the 32-bit MAPI property tag associated with the property, such as CdoPR_MESSAGE_FLAGS. To access a named property, use objMessageFilter.Fields(name), where name is a string that represents the custom property name.
Note Not all message stores support filtering on all possible fields, that is, on all possible MAPI properties. A store typically returns CdoE_TOO_COMPLEX if you specify a property on which it does not support filtering.
Although the Fields property itself is read-only, the collection it returns can be accessed in the normal manner through its Add and Delete methods, and the properties on its member Field objects retain their respective read/write or read-only accessibility.