Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

MIMEItemToFile Function

Overview

The MIMEItemToFile function extracts an entry from a MIME Object to a specified file.

Syntax/Parameters

Syntax

int = MIMEItemToFile ( handle hMIME, int index, string filename );

Parameters

hMIME

A handle for a MIME Object created with the MIMEOpen function.

index

An int specifying the zero-based index for an item within the MIME Object.

filename

A string containing a fully qualified filename and path. or a path location. If the path is only provided (with a trailing backslash (‘\’), the entry must have a filename. The filename will be combined to create a qualified destination filename.

Return Value

Returns an int as ERROR_NONE or a formatted error code.

Remarks

If the specified destination file already exists, it will be overwritten.

If a content-alternate layer entry is selected, it is automatically an 8-bit ASCII string. It is up to the caller to decode the content.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic