Share via


IMessageFormHostEx::GetGlobalSetting

4/8/2010

The GetGlobalSetting method gets the value of the global setting from the e-mail application.

Note

This host method is the same one provided as part of IMailSyncCallBack:: GetGlobalSetting.

Syntax

HRESULT GetGlobalSetting (
  LPCWSTR pszSetting,
  LPSPropValue pval
);

Parameters

  • pszSetting
    [in] Reference to settings (string values defined in cemapi.h) maintained by the e-mail application.
  • pval
    [out] Reference to an SPropValue structure that the e-mail application sets with the value.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    Indicates success.

Remarks

If the value returned by the e-mail application is a string, do not use the IMailSyncCallback::FreeMem method to free the memory. The following table lists the set of possible global property string values.

Constant WCHAR setting String value

kszCapSaveSent[]

"SaveSent"

kszCapSMSUnicode[]

"SMSUnicode"

kszCapIncludeOriginal[]

"IncludeOriginal"

kszCapIndentBody[]

"IndentBody"

kszCapAddLeading[]

"AddLeading"

kszCapLeadChar[]

"LeadChar"

kszCapSMSRequestStatus[]

"SMSRequestStatus"

kszCapSMTPAllowAuthLogin[]

"SMTPAllowAuthLogin"

kszCapDeleteAction[]

"DeleteAction"

kszCapReturnAddress[]

"ReturnAddress"

Requirements

Header cemapi.h
Library cemapi.lib
Windows Embedded CE Windows CE .NET 4.2 and later
Windows Mobile Pocket PC for Windows Mobile 2003 and later, Smartphone for Windows Mobile 2003 and later

See Also

Reference

IMailSyncCallBack::FreeMem
IMessageFormHostEx
IMessageFormHostEx::SetGlobalSetting

Other Resources

Messaging