Save(Stream,TwainImageEncoderSettings) Method (AcquiredImage)

In This Topic

Saves this image to a specified stream in the specified format and with specified encoder settings.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Overloads Sub Save( _
   ByVal streamThe System.IO.Stream where the image must be saved.
 As System.IO.Stream, _
   ByVal encoderSettingsEncoder settings.
 As Vintasoft.WinTwain.ImageEncoders.TwainImageEncoderSettings _
)

public void Save(
   System.IO.Stream stream, 
   Vintasoft.WinTwain.ImageEncoders.TwainImageEncoderSettings encoderSettings
)

public: void Save(
   System.IO.Stream* stream, 
   Vintasoft.WinTwain.ImageEncoders.TwainImageEncoderSettings* encoderSettings
)

public:
void Save(
   System.IO.Stream^ stream, 
   Vintasoft.WinTwain.ImageEncoders.TwainImageEncoderSettings^ encoderSettings
)

Parameters

stream: The System.IO.Stream where the image must be saved.
encoderSettings: Encoder settings.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if stream is null or encoderSettings is null.
TwainException	Thrown if error occurs at the image saving.

Remarks

Image can be:
- saved as image file (BMP, JPEG, PNG, TIFF)
- added to multipage TIFF file
- saved into new PDF or PDF/A document
- added to existing PDF or PDF/A document

Available compressions for images saved into TIFF file:
- without compression
- CCITT Group 4 Fax compression
- LZW compression
- ZIP compression
- JPEG compression

Available compressions for images saved into PDF document:
- without compression
- CCITT Group 4 Fax compression
- LZW compression
- ZIP compression
- JPEG compression

Image can be added to a PDF document compatible with version 1.4 or earlier of PDF standard.

Image will be saved as BMP file if encoderSettings is not null and encoderSettings is an /// instance of type TwainBmpEncoderSettings.

Image will be saved as JPEG file if encoderSettings is not null and encoderSettings is an instance of type TwainJpegEncoderSettings.

Image will be saved as PDF file if encoderSettings is not null and encoderSettings is an instance of type TwainPdfEncoderSettings.

Image will be saved as PNG file if encoderSettings is not null and encoderSettings is an instance of type TwainPngEncoderSettings.

Image will be saved as TIFF file if encoderSettings is not null and encoderSettings is an instance of type TwainTiffEncoderSettings.

Example

Please see example here: GetAsStream(TwainImageEncoderSettings).

Requirements

Target Platforms: .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

AcquiredImage Class
AcquiredImage Members

SaveToStream(Stream,TwainImageEncoderSettings)
Overload List

Send Feedback