IHTTPMailTransport2::FolderMemberInfo method

[IHTTPMailTransport2::FolderMemberInfo is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Returns the properties for the specified collection resource.

Syntax

HRESULT FolderMemberInfo(
  [in] LPCSTR          pszPath,
  [in] MEMBERINFOFLAGS flags,
  [in] DWORD           dwDepth,
  [in] BOOL            fIncludeRoot,
  [in] DWORD           dwContext,
  [in] LPCSTR          pszFolderTimeStamp,
  [in] LPCSTR          pszFolderName
);

Parameters

pszPath [in]

Type: LPCSTR

Specifies an LPCSTR that contains a null-terminated string that is the complete URL to the collection resource.

flags [in]

Type: MEMBERINFOFLAGS

Specifies one or more values from the MEMBERINFOFLAGS enumeration.

dwDepth [in]

Type: DWORD

Specifies a DWORD that indicates the value of the DEPTH request header.

Value Meaning
0
Apply only to the specified resource.
1
Apply to the specified resource and its children.
DEPTH_INFINITY
0xFFFFFFFE
Apply to the specified resource and to all descendants.

fIncludeRoot [in]

Type: BOOL

Specifies a BOOL that indicates whether to exclude the resource and apply the command only to its childen by including the "noroot" token in the DEPTH header. If dwDepth is 0 then this parameter must be FALSE.

dwContext [in]

Type: DWORD

Currently unused. Should be set to zero.

pszFolderTimeStamp [in]

Type: LPCSTR

Specifies an LPCSTR that contains the timestamp to log.

pszFolderName [in]

Type: LPCSTR

Specifies an LPCSTR that contains folder name.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
Indicates success.
E_INVALIDARG
Indicates that pszPath is NULL.
E_OUTOFMEMORY
Indicates that an attempt to allocate memory failed.

Requirements

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