Preview Method (TwainScanningService)

C#
Visual Basic
Objective-C
Java
C++

public virtual Stream Preview( 
   string id,
   int pageNumber,
   string commandName,
   string arguments,
   int width,
   int height,
   RasterImageFormat format,
   int bpp,
   object userData
)

'Declaration
 
Public Overridable Function Preview( _
   ByVal id As String, _
   ByVal pageNumber As Integer, _
   ByVal commandName As String, _
   ByVal arguments As String, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal format As RasterImageFormat, _
   ByVal bpp As Integer, _
   ByVal userData As Object _
) As Stream

'Usage
 
Dim instance As TwainScanningService
Dim id As String
Dim pageNumber As Integer
Dim commandName As String
Dim arguments As String
Dim width As Integer
Dim height As Integer
Dim format As RasterImageFormat
Dim bpp As Integer
Dim userData As Object
Dim value As Stream
 
value = instance.Preview(id, pageNumber, commandName, arguments, width, height, format, bpp, userData)

public:
virtual Stream^ Preview( 
   String^ id,
   int pageNumber,
   String^ commandName,
   String^ arguments,
   int width,
   int height,
   RasterImageFormat format,
   int bpp,
   Object^ userData
)

Parameters

id: The scanning session Id.
pageNumber: 1-based page number.
commandName: The command name.
arguments: The command arguments.
width: The image width.
height: The image height.
format: The image format.
bpp: The image bits-per-pixel.
userData: The user data.

Return Value

Gets an image of the preview of the command.

Target Platforms

Reference

TwainScanningService Class
TwainScanningService Members