MAPIFolder.GetCustomIcon Method

Reference

Definition

Namespace:: Microsoft.Office.Interop.Outlook

Assembly:: Microsoft.Office.Interop.Outlook.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns an StdPicture object that represents the custom icon for the folder.

public:
 stdole::StdPicture ^ GetCustomIcon();

public stdole.StdPicture GetCustomIcon ();

Public Function GetCustomIcon () As StdPicture

Returns

StdPicture

Returns an StdPicture object that represents a custom icon for the folder.

Remarks

The returned StdPicture object has its Type property equal to PICTYPE_ICON or PICTYPE_BITMAP.

GetCustomIcon returns Nothing (a null reference (Nothing in Visual Basic) in C#) if the folder does not have a custom folder icon, or if the folder belongs to one of the following groups of folders:

You can only call GetCustomIcon from code that runs in-process as Outlook. An StdPicture object cannot be marshaled across process boundaries. If you attempt to call GetCustomIcon from out-of-process code, an exception occurs.

Applies to