IStoreNamespace::RenameFolder method

  • Article

Renames a user-created message folder.

Syntax

HRESULT RenameFolder(
  [in] STOREFOLDERID dwFolderId,
  [in] DWORD         dwReserved,
  [in] LPCSTR        pszNewName
);

Parameters

dwFolderId [in]

Type: STOREFOLDERID

Specifies the folder to be renamed.

dwReserved [in]

Type: DWORD

Reserved value. Must be 0.

pszNewName [in]

Type: LPCSTR

Specifies the new display name for the 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 dwFolderId is invalid, dwReserved is not 0, or pszNewName is NULL.
MSOEAPI_E_STORE_INITIALIZE
 The namespace has not been initialized. To initialize the namespace, call IStoreNamespace::Initialize.

Remarks

Only user-created folders can be renamed. Special folders cannot be renamed.

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)