GetClosedCaptioningTargetFile Method

Summary

Retrieves the filename and flags set using SetClosedCaptioningTargetFile.

Syntax
C#
VB
C++
public virtual void GetClosedCaptioningTargetFile( 
   out string FileName, 
   out ClosedCaptioningFlags Flags 
) 
Public Overridable Sub GetClosedCaptioningTargetFile( _ 
   ByRef FileName As String, _ 
   ByRef Flags As ClosedCaptioningFlags _ 
)  
public: 
virtual void GetClosedCaptioningTargetFile(  
   [Out] String^ FileName, 
   [Out] ClosedCaptioningFlags Flags 
)  

Parameters

FileName
Ouput variable which receives the name of the file used to save the closed captioning data.

Flags
Ouput variable which receives the value of flags that used to save the closed captioning data. For a list of possible values, refer to ClosedCaptioningFlags enumeration values.

Remarks

This method retrieves null and zero flag if no filename has been set.

Example
C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void ClosedCaptioningTargetFile() 
{ 
   // reference the convert control 
   ConvertCtrl convertctrl = _form.ConvertCtrl; 
 
   // target file 
   string targetFileCc = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ClosedCaptioningTargetFile.srt"); 
   ClosedCaptioningFlags flags = ClosedCaptioningFlags.Default; 
   string testFile; 
   ClosedCaptioningFlags testFlags; 
 
   try 
   { 
      // set target file name and save options 
      convertctrl.SetClosedCaptioningTargetFile(targetFileCc, flags); 
 
      convertctrl.GetClosedCaptioningTargetFile(out testFile, out testFlags); 
 
      if (testFile == targetFileCc && testFlags == flags) 
         _result = true; 
      else 
         _result = false; 
   } 
   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 ClosedCaptioningTargetFile() 
   ' reference the convert control 
   Dim convertctrl As ConvertCtrl = _form.ConvertCtrl 
 
   ' target file 
   Dim targetFileCc As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ClosedCaptioningTargetFile.srt") 
   Dim flags As ClosedCaptioningFlags = ClosedCaptioningFlags.Default 
   Dim testFile As String = String.Empty 
   Dim testFlags As ClosedCaptioningFlags 
 
   Try 
 
      ' set target file name and save options 
      convertctrl.SetClosedCaptioningTargetFile(targetFileCc, flags) 
 
      convertctrl.GetClosedCaptioningTargetFile(testFile, testFlags) 
 
      If testFile = targetFileCc AndAlso testFlags = flags Then 
         _result = True 
      Else 
         _result = False 
      End If 
   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.11.25
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly