Platform SDK: SMTP Server Events

IMailMsgRecipientsBase::GetStringA

[This is preliminary documentation and subject to change.]

Read a recipient string property.

HRESULT GetStringA(
  [in] DWORD dwIndex,
  [in] DWORD dwPropID,
  [in] DWORD cchLength,
  [out,size_is(cchLength)] LPSTR pszValue
);
dwIndex
Specifies the zero-based index of the recipient.
dwPropID
Specifies the property ID.
cchLength
Specifies the length in characters (including the terminating NULL) of the buffer to receive the value.
pszValue
Receives the value.

Return Values

Value Description
S_OK Success.
S_FALSE Success. The property was not present.
STG_E_NOMOREFILES Error. The recipient was not present.

See Also

IMailMsgRecipientsBase.PutStringA