OpenLogFile Method

Summary

Opens a log file for convert control operation details.

Syntax
C#
VB
C++
public virtual void OpenLogFile( 
   string fileName, 
   LogFileFlags flags 
) 
Public Overridable Sub OpenLogFile( _ 
   ByVal fileName As String, _ 
   ByVal flags As LogFileFlags _ 
)  
public: 
virtual void OpenLogFile(  
   String^ fileName, 
   LogFileFlags flags 
)  

Parameters

fileName
A string that contains the name of the file to be used to save the logging information.

flags
Value that represents the desired logging options. For a list of possible values, refer to LogFileFlags enumeration values.

Remarks

Opens a log file for convert control operation details. Use the CloseLogFile method to stop logging data to the file and close the file. If the filename passed to the filename parameter is an empty string, then the method will return an error. If the filename passed to the filename parameter currently exists, and the LogFileFlags.Append flag has not been passed in the flags parameter the existing file will be overwritten.

Example
C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void LogFileExample() 
{ 
   // reference the convert control 
   ConvertCtrl convertctrl = _form.ConvertCtrl; 
 
   // input and output files 
   string inFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi"); 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_HasDialogExample.avi"); 
 
   // log file 
   string logFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Log.txt"); 
 
   try 
   { 
      // set the source for conversion 
      convertctrl.SourceFile = inFile; 
 
      // set the video and audio compressors 
      convertctrl.VideoCompressors.Mpeg2.Selected = true; 
      convertctrl.AudioCompressors.AC3.Selected = true; 
 
      // set the target output file and format 
      convertctrl.TargetFile = outFile; 
 
      // set the target output format 
      convertctrl.TargetFormat = TargetFormatType.AVI; 
 
      // set the log file for conversion process  
      // information logging 
      convertctrl.OpenLogFile(logFile, LogFileFlags.SourceInfo | LogFileFlags.GraphBuilder | LogFileFlags.StreamInfo); 
 
      // start the capture process 
      convertctrl.StartConvert(); 
 
      // we'll loop on the state and pump messages for this example. 
      // but you should not need to if running from a Windows Forms application. 
      while (convertctrl.State == ConvertState.Running) 
         Application.DoEvents(); 
 
      // close the log file 
      convertctrl.CloseLogFile(); 
 
      // set the result to what we expect 
      _result = (File.Exists(logFile)); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
} 
Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As ConvertCtrlForm = New ConvertCtrlForm() 
 
Public Sub LogFileExample() 
   ' reference the convert control 
   Dim convertctrl As ConvertCtrl = _form.ConvertCtrl 
 
   ' input and output files 
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi") 
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_HasDialogExample.avi") 
 
   ' log file 
   Dim logFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Log.txt") 
 
   Try 
      ' set the source for conversion 
      convertctrl.SourceFile = inFile 
 
      ' set the video and audio compressors 
      convertctrl.VideoCompressors.Mpeg2.Selected = True 
      convertctrl.AudioCompressors.AC3.Selected = True 
 
      ' set the target output file and format 
      convertctrl.TargetFile = outFile 
 
      ' set the target output format 
      convertctrl.TargetFormat = TargetFormatType.AVI 
 
      ' set the log file for the conversion process  
      ' information logging 
      convertctrl.OpenLogFile(logFile, LogFileFlags.SourceInfo Or LogFileFlags.GraphBuilder Or LogFileFlags.StreamInfo) 
 
      ' start the capture process 
      convertctrl.StartConvert() 
 
      ' we'll loop on the state and pump messages for this example. 
      ' but you should not need to if running from a Windows Forms application. 
      Do While convertctrl.State = ConvertState.Running 
         Application.DoEvents() 
      Loop 
 
      ' close the log file 
      convertctrl.CloseLogFile() 
 
      ' set the result to what we expect 
      _result = (File.Exists(logFile)) 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly