|
|
| INT
PopStoreMessage(
|
|
|
HCLIENT
hClient, |
|
|
|
|
UINT
nMessageId, |
|
|
|
|
LPCTSTR
lpszFileName |
|
|
| );
|
The PopStoreMessage function stores a message in the
specified file.
Parameters
- hClient
- Handle to the client session.
- nMessageId
- Number of message to retrieve. This value must be greater than
zero. The first message in the mailbox is message number one.
- lpszFileName
- Pointer to a null-terminated string which specifies the file
that message is to be stored in. If an empty string or NULL pointer
is passed as an argument, the message is copied to the system
clipboard.
Return Value
If the function succeeds, the return value is zero. If the
function fails, the return value is POP_ERROR. To get extended
error information, call PopGetLastError.
Remarks
The PopStoreMessage function 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 asynchronous mode.
Requirements
Client: Requires Windows Vista, Windows XP or Windows
2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or
Windows 2000 Server.
Header: Include cstools6.h.
Library: Use cspopav6.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
PopGetMessage, PopGetMessageHeaders, PopGetTransferStatus, PopSendMessage
|
|