Fields Property (Folder Object)
Fields Property (Folder Object)
The Fields property returns a single Field object or a Fields collection object. Read-only.
Syntax
objFolder.Fields
objFolder.Fields(index)
objFolder.Fields(proptag)
objFolder.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 Folder 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 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 objFolder.Fields(proptag), where proptag is the 32-bit MAPI property tag associated with the property, such as CdoPR_CONTENT_COUNT. To access a named property, use objFolder.Fields(name), where name is a string that represents the custom property name.
Note The Microsoft® Exchange Server supports only predefined MAPI properties on folders. You cannot add or define custom named properties on Microsoft Exchange Server folders. Other servers may support named properties on folders, however.
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.
The Fields property does not correspond to a MAPI property and cannot be rendered into HTML hypertext by the CDO Rendering Library.
Example
This code fragment displays the field name or identifier value of all Field Object objects within the Fields collection:
' many properties are MAPI properties and have no names
' for those properties, display the ID
' fragment from Field_Name
' assume objFieldColl, objOneField are valid objects
For i = 1 to objFieldColl.Count Step 1
Set objOneField = objFieldColl.Index(i)
If "" = objOneField.Name Then
MsgBox "Field has no name; ID = " & objOneField.ID
Else
MsgBox "Field name = " & objOneField.Name
End If
Next i