CreateAttachmentStream Method

Summary

Creates a stream to the attachment file binary data.

Syntax

C++

public Stream CreateAttachmentStream( 
   int attachmentNumber, 
   ObjectCache cache 
)

Public Function CreateAttachmentStream( 
   ByVal attachmentNumber As Integer, 
   ByVal cache As ObjectCache 
) As Stream

public:  
   Stream^ CreateAttachmentStream( 
      Int32 attachmentNumber, 
      ObjectCache^ cache 
   )

attachmentNumber

1-based attachment number in this LEADDocument. This DocumentAttachments collection must contain an item with DocumentAttachment.AttachmentNumber equal to this value, otherwise an exception is thrown.

cache

Cache object to use. This is optional, see the Remarks section.

Stream to the attachment file binary data if successful; otherwise, null. The application program must close (dispose) the stream after use.

Remarks

CreateAttachmentStream works as follows:

Obtains the DocumentAttachment object identified by attachmentNumber.
If the value of DocumentAttachment.DocumentId is not null, then it is assumed that the attachment document exists in the cache, and a stream to its data is created and returned.
Otherwise, if the value of DocumentAttachment.IsEmbedded is true then it is assumed that the attachment is embedded in the owner document, and a stream to its data is created and returned.
If all of the above fails, then null is returned.