3.2.4.2.5.11 MailSubject (get) (Opnum 22)

The MailSubject (get) method returns the mail subject property of the action. The mailSubject parameter contains a string value that is the subject line of the email generated by this action.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_ACTION_EMAIL | 0x06))] HRESULT MailSubject(
   [out, retval] BSTR* mailSubject
 );

mailSubject: A pointer to a variable that, upon completion, contains the string value of the subject of the action.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The mailSubject parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that mailSubject is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The server MUST set mailSubject to the string value of the subject of the action.

The mail subject property of the action that is returned can contain macros, as specified in section 3.2.4.3. If this is the case, the server MUST return the subject of the action without having resolved any of the macros.