SaveAsIStream Method (GdPictureImaging)

'Declaration
 
Public Function SaveAsIStream( _
   ByVal ImageID As Integer, _
   ByVal Stream As IStream, _
   ByVal ImageFormat As DocumentFormat, _
   ByVal EncoderParameter As Integer _
) As GdPictureStatus

public GdPictureStatus SaveAsIStream( 
   int ImageID,
   IStream Stream,
   DocumentFormat ImageFormat,
   int EncoderParameter
)

public function SaveAsIStream( 
    ImageID: Integer;
    Stream: IStream;
    ImageFormat: DocumentFormat;
    EncoderParameter: Integer
): GdPictureStatus; 

public function SaveAsIStream( 
   ImageID : int,
   Stream : IStream,
   ImageFormat : DocumentFormat,
   EncoderParameter : int
) : GdPictureStatus;

public: GdPictureStatus SaveAsIStream( 
   int ImageID,
   IStream* Stream,
   DocumentFormat ImageFormat,
   int EncoderParameter
) 

public:
GdPictureStatus SaveAsIStream( 
   int ImageID,
   IStream^ Stream,
   DocumentFormat ImageFormat,
   int EncoderParameter
) 

Parameters

ImageID

GdPicture image identifier.

Stream

The IStream object to save the image.

ImageFormat

A member of the DocumentFormat enumeration. Currently supported formats are:

DocumentFormatBMP.

DocumentFormatJPEG.

DocumentFormatPNG.

DocumentFormatTIFF.

DocumentFormatGIF.

DocumentFormatJ2K (JPEG2000 codestream).

DocumentFormatJP2 (JPEG2000)

DocumentFormatTARGA.

DocumentFormatEXR.

DocumentFormatWBMP.

DocumentFormatXPM.

DocumentFormatPBM.

DocumentFormatWMF.

DocumentFormatWEBP.

EncoderParameter

Compression or encoding quality to use.

For JPEG format: the parameter defines the quality between 1 (lower) and 100 (higher).

For WebP format: the parameter defines the quality between 1 (lower) and 100 (higher - lossless encoding).

For TIFF format: the parameter defines the compression scheme to be used: 1 for none, 2 for RLE, 3 for CCITT3, 4 for CCITT4, 5 for LZW, 7 for JPEG, 32946 for Deflate and 65536 for automatic compression adjustment. For more options the SaveAsTiff() method taking a Stream object as parameter can be used.

For JPEG2000 format: the parameter defines the compression rate Between [1(MaxQuality - Lossless) ... 512(Poor quality)]. Default value is 16.

For PNG format: the parameter defines the compression level Between [0(no compression - faster encoding) ... 9(max compression - slower encoding)]. Default value is 6.

For other formats use 0.

Return Value

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members