:SetMessageText()
Class
Syntax
:SetMessageText(cText, [nOffset], [hMessage] ) -> nBytes
Parameters
|
|
cText |
Text to write into the Message Part. |
|
|
nOffset |
Optional. The offset into the body of the message part. If no nOffset value is provided, the text is will be appended to the message body. |
|
|
hMessage |
Optional. Handle of the message to act on. Provided during :CreateMessage() operation |
Return
If the function succeeds, the return value is the number of bytes copied into the message. A return value of zero indicates that no text could be copied into the current message part. To get extended error information, look at :nErr and :cErr
Description
The :SetMessageText() method copies the specified text into the body of the current message part.
See Also
:SetMessagePart(), :GetMessagePart(), :CreateMessagePart()