ExtractFile Method

Extract the contents of a file attachment and store it on the local system.

Syntax

object.ExtractFile( FileName )

Remarks

The ExtractFile method writes the contents of a message part, typically a file attachment, to a file on the local system. This method will automatically decode any binary file attachments.

FileName
A string which specifies the name of the file that the attachment is to be written to. If the file does not exist, it will be created. If the file exists, it will be overwritten.

Return Value

A value of zero is returned if the action was successful. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

See Also

Attachment Property, AttachData Method, AttachFile Method, ExportMessage Method


Copyright © 2008 Catalyst Development Corporation. All rights reserved.