ConvertToPDF Method

Description

Converts the specified object file to PDF format.

Syntax

Visual Basic
Public Function ConvertToPDF( _ ByVal ObjVer As ObjVer, _ ByVal FileID As Long, _ Optional ByVal StoreAsSeparateFile As Boolean = False, _ Optional ByVal OverwriteExistingFile As Boolean = False, _ Optional ByVal PDFA1b As Boolean = False, _ Optional ByVal FailOnUnsupportedSourceFiles As Boolean = True _ ) As ObjectVersion

Visual Basic

Public Function ConvertToPDF( _
   ByVal ObjVer As ObjVer, _
   ByVal FileID As Long, _
   Optional ByVal StoreAsSeparateFile As Boolean = False, _
   Optional ByVal OverwriteExistingFile As Boolean = False, _
   Optional ByVal PDFA1b As Boolean = False, _
   Optional ByVal FailOnUnsupportedSourceFiles As Boolean = True _
) As ObjectVersion

Parameters

ObjVer: Object version for the object that contains the file to be converted.
FileID: The ID for the file to be converted.
StoreAsSeparateFile: If true, the converted PDF will be stored as a separate file instead of overwriting the original one. Otherwise the file original file will be replaced with a similarly named file with the .pdf extension.
OverwriteExistingFile: If true, the conversion will overwrite any file that has the same name as the target file.
PDFA1b: If true, the converted file will be in PDF/A1-b format.
FailOnUnsupportedSourceFiles: If true, an error is thrown when trying to convert an unsupported file format. Otherwise the conversion is silently skipped.

Remarks

This method is available only if M-Files API is used in the server interface mode.