In This Topic ▼

Remove Method

Summary

Removes a TargetFormat item from the collection.

Syntax

C++/CLI

public bool Remove( 
   TargetFormat item 
)

public: 
bool Remove(  
   TargetFormat^ item 
)

Parameters

item
The TargetFormat to be removed.

Return Value

System.Boolean

Remarks

Removes the specified TargetFormat item. Predefined read-only formats cannot be removed. If the method fails, an error is raised. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void AddExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set an audio device first.  use your audio device's name here 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // reference the target formats collection 
      TargetFormats formats = capturectrl.TargetFormats; 
 
      // formats count before adding new one. 
      int nCount = formats.Count; 
 
      // demonstrating the add property, Add new format at the end of the collection 
      formats.Add("My Format", -1); 
 
      // get the newly added format 
      TargetFormat myFormat = capturectrl.TargetFormats[capturectrl.TargetFormats.Count - 1]; 
 
      // demonstrating the remove property, Remove new format from the end of the collection 
      formats.Remove(myFormat); 
 
      // set the result to what we expect 
      _result = (nCount == formats.Count); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

TargetFormats Class

TargetFormats Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies