VintaSoft Twain .NET SDK v10.2
FileName Property (Device)
Example 




Vintasoft.WpfTwain Namespace > Device Class : FileName Property
Gets or sets the path to a file where next acquired image should be saved when File transfer mode is used.
Syntax
'Declaration
 
Public Property FileName As String
'Usage
 
Dim instance As Device
Dim value As String
 
instance.FileName = value
 
value = instance.FileName
public string FileName {get; set;}
public: __property string* get_FileName();
public: __property void set_FileName( 
   string* value
);
public:
property String^ FileName {
   String^ get();
   void set (    String^ value);
}

Property Value

Default value is "test.bmp". Path must contain not more than 255 symbols.
Exceptions
ExceptionDescription
Thrown if value is null.
Thrown if value has wrong length.
Example
This example shows how to acquire images directly to TIFF files.
Public Sub AcquireImagesUsingFileTransferModeAsJpegFiles()
    Using deviceManager As New DeviceManager()
        ' open the device manager
        deviceManager.Open()
            
        ' get reference to the default device
        Dim device As Device = deviceManager.DefaultDevice
            
        device.ShowUI = False
        device.DisableAfterAcquire = True
            
        ' open the device
        device.Open()
            
        ' set acquisition parameters
        device.TransferMode = TransferMode.File
        device.FileFormat = TwainImageFileFormat.Jpeg
        device.FileJpegQuality = 70
            
        Dim imageCount As Integer = 0
        ' set filename the first acquired image
        device.FileName = String.Format("c:\images\page{0}.jpg", System.Math.Max(System.Threading.Interlocked.Increment(imageCount), imageCount - 1))
            
        ' acquire images from device
        Dim acquireModalState1 As AcquireModalState = AcquireModalState.None
        Do
            acquireModalState1 = device.AcquireModal()
            Select Case acquireModalState1
                Case AcquireModalState.ImageAcquired
                    ' set filename for next acquired image
                    device.FileName = String.Format("c:\images\page{0}.jpg", System.Math.Max(System.Threading.Interlocked.Increment(imageCount), imageCount - 1))
                    Exit Select
            End Select
        Loop While acquireModalState1 <> AcquireModalState.None
            
        ' close the device
        device.Close()
            
        ' close the device manager
        deviceManager.Close()
    End Using
End Sub
public void AcquireImagesUsingFileTransferModeAsJpegFiles()
{
    using (DeviceManager deviceManager = new DeviceManager())
    {
        // open the device manager
        deviceManager.Open();
            
        // get reference to the default device
        Device device = deviceManager.DefaultDevice;
            
        device.ShowUI = false;
        device.DisableAfterAcquire = true;
            
        // open the device
        device.Open();
            
        // set acquisition parameters
        device.TransferMode = TransferMode.File;
        device.FileFormat = TwainImageFileFormat.Jpeg;
        device.FileJpegQuality = 70;
            
        int imageCount = 0;
        // set filename the first acquired image
        device.FileName = string.Format(@"c:\images\page{0}.jpg", imageCount++);
            
        // acquire images from device
        AcquireModalState acquireModalState = AcquireModalState.None;
        do
        {
            acquireModalState = device.AcquireModal();
            switch (acquireModalState)
            {
                case AcquireModalState.ImageAcquired:
                    // set filename for next acquired image
                    device.FileName = string.Format(@"c:\images\page{0}.jpg", imageCount++);
                    break;
            }
        }
        while (acquireModalState != AcquireModalState.None);
            
        // close the device
        device.Close();
            
        // close the device manager
        deviceManager.Close();
    }
}
Requirements

Target Platforms: Windows 8, Windows 7, Windows Vista, Windows XP, Windows Server 2012, Windows Server 2008, Windows Server 2003

See Also

Reference

Device Class
Device Members
FileFormat Property
TransferMode Property