IStoreNamespace::GetNextSubFolder method

Continues enumeration of folders using a provided handle and retrieves information about the next result.

Syntax

HRESULT GetNextSubFolder(
  [in]      HENUMSTORE    hEnum,
  [in, out] LPFOLDERPROPS pProps
);

Parameters

hEnum [in]

Type: HENUMSTORE

Handle that specifies an existing enumeration to continue.

pProps [in, out]

Type: LPFOLDERPROPS

Pointer to a FOLDERPROPS structure that receives information about the enumerated folder.

Return value

Type: HRESULT

The function will return S_OK if there are more folders to enumerate. If there are no more folders, the function will return S_FALSE. If an error occurs, one of the following error codes will be returned.

Return code Description
E_INVALIDARG
The value of pProps is NULL or hEnum is invalid.
MSOEAPI_E_STORE_INITIALIZE
The namespace has not been initialized. To initialize the namespace, call IStoreNamespace::Initialize.

Remarks

The first argument to this method is the handle to an existing enumeration. To get a handle, you must first call IStoreNamespace::GetFirstSubFolder.

When you have completed enumerating folders, call IStoreNamespace::GetSubFolderClose to free memory associated with the enumeration.

The enumeration is not recursive.

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)

See also

IStoreNamespace

Reference

GetFirstSubFolder

GetSubFolderClose