IHTTPMailTransport::GetPropertyDw method

  • Article

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

Retrieves the specified DWORD account property synchronously or asynchronously.

Syntax

HRESULT GetPropertyDw(
  [in]  HTTPMAILPROPTYPE proptype,
  [out] LPDWORD          lpdwProp
);

Parameters

proptype [in]

Type: HTTPMAILPROPTYPE

Specifies a property from the HTTPMAILPROPTYPE enumeration whose data type is DWORD.

lpdwProp [out]

Type: LPDWORD

Receives an LPDWORD that contains the value of the property specified by proptype.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates success.
E_INVALIDARG
 Indicates that proptype is invalid, for example, HTTPMAIL_PROP_INVALID or HTTPMAIL_PROP_LAST.
E_FAIL
 Indicates that the server is not available.
E_PENDING
 Indicates that there are no root properties or lpdwProp is NULL. The property value is being returned asynchronously.
IXP_E_HTTP_ROOT_PROP_NOT_FOUND
 Indicates that the root properties request succeeded. The server returned XML that did not contain the specific root property requested by the client.

Remarks

If the property is immediately available, the function returns it synchronously, and the result of the function is S_OK. In the sync case, it is the client's responsibility to free the property string by calling CoTaskMemFree. If the property is not immediately available, the function result is E_PENDING, and the result is returned through the callback's OnResponse method.

The caller can force the call to return asynchronously by passing a nulllpdwProp. The call cannot force the call to return synchronously.

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)