(Document/Medical only) Gets all available configurations for the current session.
Syntax
Parameters
- bitsPerPixel
- The resulting file's pixel depth.
Note that not all bits per pixel are available to all file formats. Use 0 for bitsPerPixel to store the file using the closest BitsPerPixel value supported by that format. - transferMechanism
- The TWAIN transfer mode to use.
- bufferIteration
- The number of memory configurations that will be tested. The maximum value for this parameter is 10.
Return Value
An array of the available configurations for the current session.
Example
| Visual Basic | Copy Code |
|---|
Public Sub FindConfigurationExample(ByVal parent As IWin32Window)
Dim session As TwainSession = New TwainSession()
session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)
Try
Dim twFastConfigs As RasterCollection(Of TwainFastConfiguration) = session.FindConfiguration(1, TwainTransferMechanism.Memory, 5)
MessageBox.Show("GetScanConfigs method was successful.")
Dim msg As String
msg = String.Format("Scan Configuration count = {0}" & Constants.vbLf, twFastConfigs.Count)
MessageBox.Show(msg)
msg = String.Format("Transfer Mode = {0}" & Constants.vbLf & "File Format = {1}" & Constants.vbLf & "Buffer Size = {2}" & Constants.vbLf & "Required Time = {3}" & Constants.vbLf, twFastConfigs(0).TransferMechanism, twFastConfigs(0).ImageFormat, twFastConfigs(0).BufferSize, twFastConfigs(0).RequiredTime)
MessageBox.Show(msg, "Scan Configurations...")
Catch ex As Exception
MessageBox.Show(ex.Message, "Error!!!")
End Try
session.Shutdown()
End Sub |
| C# | Copy Code |
|---|
public void FindConfigurationExample(IWin32Window parent)
{
TwainSession session = new TwainSession();
session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);
try
{
RasterCollection<TwainFastConfiguration> twFastConfigs = session.FindConfiguration(1, TwainTransferMechanism.Memory, 5);
MessageBox.Show("GetScanConfigs method was successful.");
string msg;
msg = String.Format("Scan Configuration count = {0}\n", twFastConfigs.Count);
MessageBox.Show(msg);
msg = String.Format("Transfer Mode = {0}\nFile Format = {1}\nBuffer Size = {2}\nRequired Time = {3}\n",
twFastConfigs[0].TransferMechanism,
twFastConfigs[0].ImageFormat,
twFastConfigs[0].BufferSize,
twFastConfigs[0].RequiredTime);
MessageBox.Show(msg, "Scan Configurations...");
}
catch (Exception ex)
{
MessageBox.Show(ex.Message, "Error!!!");
}
session.Shutdown();
} |
Remarks
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7
See Also