FolderID Property (Folder Object)

Article
08/21/2009

FolderID Property (Folder Object)

The FolderID property returns the unique identifier of the subfolder's parent folder as a string. Read-only.

Syntax

objFolder.FolderID

Data Type

String

Remarks

MAPI assigns a permanent, unique identifier when an object is created. This identifier does not change from one MAPI session to another, nor from one messaging domain to another. However, MAPI does not require identifier values to be binary comparable. Accordingly, two identifiers can have different values, yet refer to the same object. In particular, one of them could be a short-term identifier and the other a long-term identifier; these are constructed using different formats.

MAPI compares identifiers with the CompareEntryIDs method, which takes into account the differences between identifier formats and returns True if the identifiers are assigned to the same object. CDO provides the CompareIDs method in the Session object, which furnishes the same functionality. For more information on entry identifiers, see the MAPI Programmer's Reference.

A Microsoft® Schedule+ calendar folder does not have a parent folder nor reside in a message store. If you obtain the default calendar folder by passing CdoDefaultFolderCalendar to the Session object's GetDefaultFolder method, the FolderID property has no defined value. An attempt to access FolderID in this case returns CdoE_NOT_FOUND.

The FolderID property corresponds to the MAPI property PR_PARENT_ENTRYID, converted to a string of hexadecimal characters. It can be rendered into HTML hypertext using the CDO Rendering ObjectRenderer object. To specify this, set the object renderer's DataSource property to this Folder object and the property parameter of the RenderProperty method to CdoPR_PARENT_ENTRYID.

Example

'          fragment from Session_Inbox
Set objFolder = objSession.Inbox
'          fragment from Folder_FolderID
strFolderID = objFolder.FolderID
MsgBox "Parent Folder ID = " & strFolderID
' later: obtain parent folder of Inbox (that is, store's root folder)
'          fragment from Session_GetFolder
If "" = strFolderID Then
    MsgBox ("Must first set folder ID variable; see Folder->ID")
    Exit Function
End If
Set objFolder = objSession.GetFolder(strFolderID)
' error checking here ...

FolderID Property (Folder Object)