CodeCarvings.Piczard
LoadImageFromFileSystem Method
See Also  Send Feedback
CodeCarvings.Piczard.Plugins Namespace > IImageArchiverPlugin Interface : LoadImageFromFileSystem Method

filePath
The path of the file containing the image to load.
useEmbeddedColorManagement
true to use color management information embedded in the image data; otherwise, false (null indicates to use the default value).
validateImageData
true to validate the image data; otherwise, false (null indicates to use the default value).
fileShare
The FileShare to use to open the file for reading.
Loads an image from the file system.

Syntax

Visual Basic (Declaration)  
Function LoadImageFromFileSystem( _
   ByVal filePath As String, _
   ByVal useEmbeddedColorManagement As Nullable(Of Boolean), _
   ByVal validateImageData As Nullable(Of Boolean), _
   ByVal fileShare As FileShare _
) As PluginOperationResult(Of LoadedImage)

Parameters

filePath
The path of the file containing the image to load.
useEmbeddedColorManagement
true to use color management information embedded in the image data; otherwise, false (null indicates to use the default value).
validateImageData
true to validate the image data; otherwise, false (null indicates to use the default value).
fileShare
The FileShare to use to open the file for reading.

Return Value

PluginOperationResult<LoadedImage> that indicates if the Plugin has handled the request.
In case of success (Handled=true) the Value property contains the image encapsulated in an instance of the LoadedImage class.

Requirements

Platforms: Windows 8, Windows 7, Windows Vista, Windows XP Professional, Windows 2000 - Windows Server family: 2012, 2008.R2, 2008, 2003, 2000

See Also

©2013 Sergio Turolla. All Rights Reserved.