GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureImaging Class / TwainGetAvailableCompressionNo Method
Index of the available file format value. Must be a value between 1 and TwainGetAvailableCompressionCount() returned value.





In This Topic
TwainGetAvailableCompressionNo Method (GdPictureImaging)
In This Topic
Returns an available compression value which can be used by the opened source in its current configuration for file transfer mode.
Syntax
'Declaration
 
Public Function TwainGetAvailableCompressionNo( _
   ByVal Number As Integer _
) As TwainCompression
public TwainCompression TwainGetAvailableCompressionNo( 
   int Number
)
public function TwainGetAvailableCompressionNo( 
    Number: Integer
): TwainCompression; 
public function TwainGetAvailableCompressionNo( 
   Number : int
) : TwainCompression;
public: TwainCompression TwainGetAvailableCompressionNo( 
   int Number
) 
public:
TwainCompression TwainGetAvailableCompressionNo( 
   int Number
) 

Parameters

Number
Index of the available file format value. Must be a value between 1 and TwainGetAvailableCompressionCount() returned value.

Return Value

If fail, returns -1 else if success, The selected compression value. A member of the TwainCompression enumeration.
Remarks
Before using this method check that the TWAIN state is >= 4 (TWAIN_SOURCE_OPEN) To get the TWAIN state, use the TwainGetState() method.
See Also