Nevron Open Vision Documentation
Nevron.Nov.Graphics Namespace / NImageSource Class / GetEncodedData Method
Specifies the format to be used when encoding the original image data (in case it is in decoded form). If this parameter is set to null, the method encodes the original raster in PNG format.
If the original image data is in encoded form, this parameter is ignored. If the original image data is in decoded form, the method uses the specified encoder settings to encode the data.


In This Topic
    GetEncodedData Method
    In This Topic
    Obtains encoded image data for this image source.
    Syntax
    'Declaration
     
    
    Public Function GetEncodedData( _
       ByVal preferredFormat As NImageFormat, _
       ByVal encoderSettings As NImageEncoderSettings _
    ) As NImageData
    'Usage
     
    
    Dim instance As NImageSource
    Dim preferredFormat As NImageFormat
    Dim encoderSettings As NImageEncoderSettings
    Dim value As NImageData
     
    value = instance.GetEncodedData(preferredFormat, encoderSettings)

    Parameters

    preferredFormat
    Specifies the format to be used when encoding the original image data (in case it is in decoded form). If this parameter is set to null, the method encodes the original raster in PNG format.
    encoderSettings
    If the original image data is in encoded form, this parameter is ignored. If the original image data is in decoded form, the method uses the specified encoder settings to encode the data.

    Return Value

    Returns encoded image data.
    Remarks
    If the original image data is in encoded form, the method creates a copy of the original data. If the original image data is in decoded form, the method encodes the original data.
    The method throws an exception if encoded data could not be obtained.
    Requirements

    Target Platforms: Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also