IMailMsgRecipientsBase::GetStringW

Platform SDK: SMTP Server Events

[This is preliminary documentation and subject to change.]

Read a recipient Unicode string property.

HRESULT GetStringW(
  [in] DWORD dwIndex,
  [in] DWORD dwPropID,
  [in] DWORD cchLength,
  [out,size_is(cchLength)] LPWSTR 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.

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