Share via

IHTTPMailTransport::CommandMOVE method

  • Article

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

Sends the MOVE command to the HTTPMail server.

Syntax

HRESULT CommandMOVE(
  [in] LPCSTR pszPath,
  [in] LPCSTR pszDestination,
  [in] BOOL   fAllowRename,
  [in] DWORD  dwContext
);

Parameters

pszPath [in]

Type: LPCSTR

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

pszDestination [in]

Type: LPCSTR

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

fAllowRename [in]

Type: BOOL

Specifies a BOOL that indicates whether the destination resource already exists and should be overwritten.

Value Meaning
FALSE
 Do not send the Overwrite request header.
TRUE
 Send the Overwrite request header and set it to TRUE.

dwContext [in]

Type: DWORD

Currently unused. Should be set to zero.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates success.
E_INVALIDARG
 Indicates that pszPath or pszDestination 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)