Facsys AFM/SDK Solgenia® Facsys™ Fax Messaging/Routing Gateway
Software Development Kit (SDK)
AFM & Web Services

Download
SDK


Contact

   
Introduction Object Model Tasks Samples & Languages Packaging Troubleshooting FAQ Appendices
   

FaxAttachments Collection Object

The FaxAttachments collection object contains one or more FaxAttachment objects and identifies the attachments belonging to a fax message.

Properties

 

Name

Data Type

Access

Class

Long

Read-only

Parent

FaxFolder object

Read-only

Session

FaxSession object

Read-only

     

Count

Long

Read-only

Item

FaxAttachment object

Read-only

 

 

Methods

 

Name

Input Parameters

Return Values

Add

FileName as String, (Optional) DisplayName as String,
(Optional) Type as Long

FaxAttachment object

Remove

Index as Long

 

RemoveAll

(None)

 
 

 

Remarks

Because a fax message may have many attachments, use the Item property to reference a particular FaxAttachment object.

Back to Top

 

Add Method

The Add method creates and returns a new FaxAttachment object in the FaxAttachments collection. The Add method also creates server based resources associated with the new attachment.

Syntax

ObjAttachments.Add(Name)

where Name is the display name of the attachment.

Back to Top

 

Count Property

The Count property returns the number of FaxAttachment objects contained in the collection. Read-only.

Syntax

ObjAttachments.Count

Data Type

Long

Back to Top

 

Item Property

The Item property returns a single FaxAttachment object from the collection. Read-only.

Syntax

ObjAttachments.Item(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of the Count property).

Data Type

FaxAttachment object

Remarks

The Item property is the default property of the FaxAttachments object.

Back to Top

 

Remove Method

The Remove method deletes the FaxAttachment object with the specified index from the collection. Server based resources associated with the attachment are also deleted.

Syntax

ObjAttachments.Remove(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of the Count property).

Remarks

The Remove method is irreversible. The attachment will be deleted permanently from the FaxAttachments collection.

If you have another reference to the deleted attachment, you can still access its properties and methods, but you cannot associate the attachment with any collection because the Add method always creates a new object.

Back to Top

 

RemoveAll Method

The RemoveAll method deletes all FaxAttachment objects from the collection. Server based resources associated with the attachments are also deleted.

Syntax

ObjAttachments.RemoveAll

Remarks

The RemoveAll method is irreversible. All attachments will be deleted permanently from the FaxAttachments collection.

Back to Top

Session

Image

Constant Definitions

Error Codes


Common Properties

Folders

Folder

Messages

Message

Recipients

Recipient

Attachments

Attachment

Phonebooks

Phonebook

Containers

Container

Entries

Entry

Fields

Field

Coverpages

Coverpage

Users

User

Home  |  Solgenia  |  Facsys  |  Facsys Support  |  Download Request  |  Contact