Share via

3.2.4.2.5.13 MessageText (get) (Opnum 24)

  • Article

The MessageText (get) method returns the message text property of the action. The messageText parameter contains a string value that is the message body of the email generated by this action.

 [propget, id(FSRM_PROPERTY (FSRM_DISPID_ACTION_EMAIL | 0x07))] HRESULT MessageText(
   [out, retval] BSTR* messageText
 );

messageText: A pointer to a variable that, upon completion, contains the string value of the message text 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 messageText parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that messageText is not NULL.

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

The server MUST set messageText to the string value of the message text of the action.

The message text 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 message text of the action without having resolved any of the macros.