DL Logo

ASFileAttachment Functions

ASFileAttachmentCreatePathName

Header: PDProcs.h:12720

Description

Creates an ASPathName corresponding to the specified file or folder in the collection.

Syntax

void ASFileAttachmentCreatePathName(PDDoc pdDoc, ASText pathText, ASFileSys *fileSys, ASPathName *pathName);

Parameters

pdDoc
The document containing the specified file or folder.
pathText
The text-based representation of the path. The path consists of a file name or sequence of file names. A file name may not contain any of the characters '\', '/', ':', ' *', '?', ' < ', ' > ', '|', and may not contain '.' as the final character. When '/' appears in a path, it signifies that the preceding file name is a folder, and that the subsequent file name is a child of that folder. The root of a collection may be identified by passing "/", NULL, or an empty string for pathText.
fileSys
A pointer that will be filled by the function. This parameter provides the caller with the ASFileSys to use in conjunction with the specified file or folder.
pathName
A pointer that will be filled by the function. This parameter provides the caller with the ASPathName to use in conjunction with the specified file or folder.

ASFileAttachmentGetPDFileAttachment

Header: PDProcs.h:12732

Description

Produces a PDFileAttachment corresponding to the ASFileSys and ASPathName. It raises an exception if the ASFileSys is is not the embedded files file system, or if the ASPathName or PDFileAttachment parameters are NULL.

Syntax

ASBool ASFileAttachmentGetPDFileAttachment(ASFileSys fileSys, ASPathName pathName, PDFileAttachment *attachment);

Parameters

fileSys
The ASFileSys for file attachments.
pathName
The ASPathName identifying the file attachment of interest.
attachment
A pointer that will be receive the file attachment.

Returns

true if the file attachment was found, false otherwise.

ASFileAttachmentGetPDFolder

Header: PDProcs.h:12744

Description

Produces a PDFolder corresponding to the ASFileSys and ASPathName. It raises an exception if the ASFileSys is is not the embedded files file system, or if the ASPathName or PDFolder parameters are NULL.

Syntax

ASBool ASFileAttachmentGetPDFolder(ASFileSys fileSys, ASPathName pathName, PDFolder *folder);

Parameters

fileSys
The ASFileSys for file attachments
pathName
The ASPathName identifying the folder of interest.
attachment
A pointer that will be receive the folder.

Returns

true if the folder was found, false otherwise.