IStoreNamespace::OpenSpecialFolder method

Opens one of the special message folders in the namespace: inbox, outbox, sent items, deleted items, and draft items. Special folders are preassigned to each namespace, and cannot be renamed, moved, or deleted.

Syntax

HRESULT OpenSpecialFolder(
  [in]  SPECIALFOLDER sfType,
  [in]  DWORD         dwReserved,
  [out] IStoreFolder  **ppFolder
);

Parameters

sfType [in]

Type: SPECIALFOLDER

Identifies the special folder to open. Must be one of the following values:

Value	Meaning
FOLDER_INBOX	Specifies the inbox folder.
FOLDER_OUTBOX	Specifies the outbox folder.
FOLDER_SENT	Specifies the sent message folder.
FOLDER_DELETED	Specifies the deleted message folder.
FOLDER_DRAFT	Specifies the draft message folder.

dwReserved [in]

Type: DWORD

Reserved value. Must be 0.

ppFolder [out]

Type: IStoreFolder**

Reference to a pointer that will receive the created IStoreFolder object that represents the opened folder.

Return value

Type: HRESULT

Returns S_OK if successful, or one of the following error values.

Return code	Description
E_INVALIDARG	The value of dwReserved is not 0, or sfType is not one of the values specified above.
MSOEAPI_E_STORE_INITIALIZE	The namespace has not been initialized. To initialize the namespace, call IStoreNamespace::Initialize.

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Product	Outlook Express 6.0
Header	Msoeapi.h
IDL	Msoeapi.idl
DLL	Inetcomm.dll (version 6.0 or later)