AddFromFile Method of the PDFAttachments Object

AddFromFile method of the PDFAttachments Object in the ABBYY FineReader Engine API — Adds the specified file to the collection of PDF attachments.

This method adds a specified file to the collection of PDF attachments.

Syntax

C++

HRESULT AddFromFile(
  BSTR             Path,
  BSTR             FileName,
  BSTR             Description,
  IPDFAttachment** Result
);

C#

IPDFAttachment AddFromFile(
  string Path,
  string FileName,
  string Description
);

Visual Basic .NET

Function AddFromFile( _
  Path As String, _
  [FileName As String = "0"], _
  [Description As String = "0"] _
) As IPDFAttachment

Parameters

Path

[in] Specifies the full path to the attachment file.

FileName

[in] Specifies the name of the attachment file. This parameter is optional and may be empty string, in which case the filename is obtained from the path.

Description

[in] Contains a user-defined description of the attachment file. This parameter is optional and may be empty string.

Result

[out, retval] A pointer to IPDFAttachment* pointer variable that receives the interface pointer of the object representing the added attachment.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

PDFAttachments