LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
OpenLogFile Method
See Also 
Leadtools.Multimedia Namespace > ConvertCtrl Class : OpenLogFile Method



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.
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.
Opens a log file for convert control operation details.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub OpenLogFile( _
   ByVal fileName As String, _
   ByVal flags As LogFileFlags _
) 
Visual Basic (Usage)Copy Code
Dim instance As ConvertCtrl
Dim fileName As String
Dim flags As LogFileFlags
 
instance.OpenLogFile(fileName, flags)
C# 
public virtual void OpenLogFile( 
   string fileName,
   LogFileFlags flags
)
C++/CLI 
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.

Example

Visual BasicCopy Code
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 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 17\Media"
End Class
C#Copy Code
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 17\Media";
}

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 file name passed to the filename parameter is an empty string, then the method will return an error. If the file name 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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also