:StoreMessage()
Class
Syntax
:StoreMessage(nMsgNo, [cFileName], [hSession]) -> lSuccess
Parameters
|
|
nMsgNo |
Message number to retrieve and save to file cFileName. |
|
|
cFileName |
File to create from message nMsgNo. If cFileName is not passed as a parameter, the message is copied to the system clipboard. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Logical indicating Success.
Returns .T. if the operation succeeds, otherwise returns .F.
To get more information about the error, see :nErr and :cErr.
Description
The :StoreMessage() method provides a method of retrieving and storing a message on the local system.
The contents of the message is stored as a text file, using the specified file name. This function always causes the caller to block until the entire message has been retrieved, even if the client has been put in asychronous mode.
See Also