SaveToOneFile Property

Summary

Gets or sets a flag that indicates whether to save multiple pages to a single file.

Syntax

C++/CLI

Python

public bool SaveToOneFile { get; set; }

public: 
property bool SaveToOneFile { 
   bool get(); 
   void set (    bool ); 
}

SaveToOneFile # get and set (WiaAcquireOptions)

Property Value

Flag that indicates whether to save multiple pages to a single file. Possible values are: true to save to a single file, false to save acquired pages to separate files. The default value is false.

Remarks

Note: This member is ignored when using WIA version 2.0.

If the SaveToOneFile member is set to false and also the WiaAcquireOptions.OverwriteExisting member is set to false, the acquire functions will generate a new file for each acquired page from the device by generating new names of the name you specified through the WiaAcquireOptions.FileName member by adding "(N)" to the end of the file name where N represents an incremented number. If the new name currently exists it will keep generating new names until it finds a new one. If the OverwriteExisting member is set to true then the acquire functions will generate a new name and check whether it exists. If it does it overwrites that file.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
       
public void AcquireToFileExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      Console.WriteLine("WIA version 1.0 not installed."); 
      return; 
   } 
 
   WiaSession wiaSession = new WiaSession(); 
   wiaSession.Startup(WiaVersion.Version1); 
 
   DialogResult res = wiaSession.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      Console.WriteLine("Error selecting WIA device."); 
      wiaSession.Shutdown(); 
      return; 
   } 
 
   // Initialize and fill the required fields from the WiaAcquireOptions structure          
   WiaAcquireOptions wiaAcquireOptions = WiaAcquireOptions.Empty; 
   wiaAcquireOptions.FileName = Path.Combine(LEAD_VARS.ImagesDir, "WiaTest.bmp"); 
   wiaAcquireOptions.OverwriteExisting = true; 
   wiaAcquireOptions.Append = false; 
   wiaAcquireOptions.SaveToOneFile = false; 
   wiaSession.AcquireOptions = wiaAcquireOptions; 
 
   wiaSession.AcquireFileEvent += new EventHandler<WiaAcquireFileEventArgs>(wiaSession_AcquireFileEvent); 
 
   wiaSession.AcquireToFile(parent, null, WiaAcquireFlags.ShowUserInterface | WiaAcquireFlags.UseCommonUI); 
 
   // Display a listing of all paths and filenames for the saved files(s). 
   if (wiaSession.FilesCount > 0) 
   { 
      string strMsg = "Acquired page(s) were saved to:\n\n"; 
      for (int i = 0; i < wiaSession.FilesCount; i++) 
      { 
         string strTemp = string.Format("{0}\n", wiaSession.FilesPaths[i]); 
         strMsg += strTemp; 
      } 
      Console.WriteLine(strMsg); 
   } 
 
   wiaSession.AcquireFileEvent -= new EventHandler<WiaAcquireFileEventArgs>(wiaSession_AcquireFileEvent); 
   wiaSession.Shutdown(); 
} 
 
public void wiaSession_AcquireFileEvent(object sender, WiaAcquireFileEventArgs e) 
{ 
   Console.WriteLine(e.Percent); 
} 
 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

WiaAcquireOptions Structure

WiaAcquireOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Wia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Wia Namespace

Assemblies