FileName (ImageKit Control/ Scan Property)

This property sets the file name when saving a file using file transfer or using memory transfer with compression.

[Visual Basic] imagekitcontrolname.Scan.FileName[ = String ]

[Visual C++] imagekitcontrolname.GetScan().SetFileName(LPCTSTR Val)

[VB.NET] imagekitcontrolname.Scan.FileName[ = String ]

[C#.NET] imagekitcontrolname.Scan.FileName[ = string ]

Property Value

The file name of the saved file

Explanation

The FileName property sets the file name when saving a file using file transfer or using memory transfer with compression. When the TransferMode property is 1 (ikScanFile) or 2 (ikScanMemory) and the Compression property is set to values other than 0 then the file will be saved according to the FileName property. (up to 255 bytes).

If the FileName property is set with an empty string, vbNullString(Visual Basic), NULL(Visual C++), Nothing(VB.NET), or null (C#.NET), or then the file cannot be saved. When using file transfer mode the a FileName property MUST be set. When the UiMode property is 2 (ikScanNONUI) and the ScanMode property is 0 (ikScanDOC), the file will be saved according to the FileName property. However, for other settings, a four digit series of numbers will be added just before the file extention. (i.e. Image.bmp will be Image0001.bmp).

Setting this value

This value can be set at runtime.

Retrieving this value

This value cannot be retrieved.