Share via

3.2.4.2.8.4 MessageText (put) (Opnum 15)

  • Article

The MessageText (put) method sets the message text property of the action. The messageText string will be used for the message of the event log generated by this action.

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_ACTION_EVENTLOG | 0x02))] HRESULT MessageText(
   [in] BSTR messageText
 );

messageText: Contains the message text to use for this action.

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

Return value/code

Description

0x8004530D

FSRM_E_OUT_OF_RANGE

The content of the messageText parameter exceeds the maximum length of 4,000 characters.

0x80070057

E_INVALIDARG

The messageText parameter is NULL or empty.

The server MUST use messageText as the message text for the event log generated by this action if it is run or return a nonzero error code.

The messageText can contain macros (section 3.2.4.3). If the messageText contains macros (section 3.2.4.3), the server MUST store messageText as provided, keeping the macros instead of resolving the macros with the values they resolve to. The server MUST allow all macros from section 3.2.4.3. The macros are resolved when the event log for this notification is generated.

The server MUST NOT alter the stored message text of the action when the macros are resolved. The message text with the resolved macro values is only used for the message of the event log being generated.