Load

Description

Writes this object's contents to the specified file.

You can use this method to extract an attached file from the database and save it to your local file system. If a file with the same name already exists at the path you specify in the filename parameter, that file must be writeable and its existing contents will be replaced. The extracted file is not a temporary file; it persists after the process using this API has terminated.

Syntax

Perl

$attachment->Load(filename); 

Identifier

Description

attachment

An Attachment object, representing the attachment of a file to a record.

filename

A String containing the path name of the file you want to write. This path name can be an absolute or relative path.

Return value

A Boolean whose value is True if the operation was successful, otherwise False.

Example

Perl

# This example assumes that there is at least 1 attachment
# field associated with the record. Otherwise, 
# GetAttachmentFields won't return anything interesting 
# and an error would be generated

# Get the collection of attachment fields
$attachfields = $entity->GetAttachmentFields();

# Get the first attachment fields
$attachfield1 = $attachfields->Item(0)

# Now get the collection of attachments from the attachments field
$attachments = $attachfield1->GetAttachments();

# Retrieve the number of attachments for the for loop
$numattachments = $attachments->Count();

for ($x = 0 ; $x < $numattachments ; $x++)
 {
 # Retrieve the correct attachment
 $attachment = $attachments->Item($x);

 # Select a filename to write to
 $filename = "C:\\attach".$x.".txt";

 # Write the file
 $status = $attachment->Load($filename);
 }