In This Topic ▼

L_FILEATTACHMENTS

Summary

A collection of attachments to a file.

Syntax

typedef struct L_FILEATTACHMENTS 
{ 
   L_UINT uStructSize; 
   L_INT OriginalFormat; 
   L_UINT uFlags; 
   L_UINT uItemStructSize; 
   L_SIZE_T uItemCount; 
   L_FILEATTACHMENT * pItems; 
} L_FILEATTACHMENTS;

Members

L_UINT uStructSize

Size of the structure. This value is set by L_ReadFileAttachments to the size of L_FILEATTACHMENTS.

L_INT OriginalFormat

Format of the owner file passed to L_ReadFileAttachments.

L_UINT uFlags

Reserved for future use. Use 0.

L_UINT uItemStructSize

Size of each item in pItems in bytes.

L_SIZE_T uItemCount

Number of items in pItems.

L_FILEATTACHMENT * pItems

Pointer to a list of L_FILEATTACHMENT items, each containing the properties of an attachment.

Comments

Applications can read the properties of the attachments included in a file by performing the following steps:

Declare a pointer of type L_FILEATTACHMENTS and set its value to NULL.
Call L_ReadFileAttachments on the owner file containing the attachments, passing the address of the L_FILEATTACHMENTS pointer.
Process the attachments. For instance, call L_ExtractAttachment to extract the attachment's file data.
Call L_FreeAttachments on the pointer to free the memory used by L_FILEATTACHMENTS.

The value of OriginalFormat will be the file format of the owner file passed to L_ReadFileAttachments. For instance, if the method was called on a PDF file then OriginalFormat will be FILE_RAS_PDF.