Integra for Notes Banner
  QuickReports Integra4Notes Integra Family of Products

Integra Script Library Documentation


Context:

Function

Library/Class:

Utilities



Function DetachFile() As

DetachFile (Note As NotesDocument, Path As String, FileName As Variant, SaveWithName As Variant, All As Integer, ShowPBar As Integer) As Integer

This function will detach one or more files from the passed on Notes document. Both, the Notes back-end document as well as the rich text item has to be declared and set before being passed on to this function.

Parameters:

    Note (NotesDocument)
      The Notes back-end document the files are attached to.
    Path (Variant)
      Path in which the to be detached files are created (saved) in.
    Filename (Variant)
      Filename is a return parameter returning the list of filenames that are detached by the process. The parameter passed on as Filename must be declared as of type Variant().
    SaveWithName (Variant)
      The name or names with which the file(s) are stored in Path. This parameter can be left blank (empty string) in which case the attachments are saved to the file-system with the same filename as they have been attached with, otherwise it has to correspond with the Filename parameter: if Filename is of type String, this parameter has to be of type String; if the Filename parameter is of type String() then this parameter has to be of type String() and for each element in FileName() one corresponding element in SaveWithName() has to exist.
    All (Integer)
      True or False. If True, files successfully attached or embedded, will be deleted from the file system.
    ShowPBar (Integer)
      True or False. If True, this function will display a progress bar.

Return Value:
    Integer. True or False.
 
QUICK LINKS
 
 

 

  © Shireburn Software Ltd. 2008 - 2024