Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.17
DiskMemory Property
See Also  Example
Leadtools.Codecs Namespace > CodecsLoadOptions Class : DiskMemory Property




Gets or sets a value indictaing whether to use disk memory when loading an image.

Syntax

Visual Basic (Declaration) 
Public Property DiskMemory As Boolean
Visual Basic (Usage)Copy Code
Dim instance As CodecsLoadOptions
Dim value As Boolean
 
instance.DiskMemory = value
 
value = instance.DiskMemory
C# 
public bool DiskMemory {get; set;}
Managed Extensions for C++ 
public: __property bool get_DiskMemory();
public: __property void set_DiskMemory( 
   bool value
);
C++/CLI 
public:
property bool DiskMemory {
   bool get();
   void set (bool value);
}

Return Value

true to load the image using disk memory; false otherwise.

Example

Visual BasicCopy Code
CodecsOptions.DiskMemory
      Public Sub DiskMemoryExample()
         RasterCodecs.Startup()
         Dim codecs As RasterCodecs = New RasterCodecs()
         Dim fileName As String = "C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"
         ' first, load the image using the default
         Dim image As RasterImage = codecs.Load(fileName)

         ' make sure the image uses conventional memory
         If image.IsConventionalMemory Then
            Console.WriteLine("This image uses conventional memory")
         Else
            MessageBox.Show("This should not happen!!")
         End If

         image.Dispose()

         ' now, load the same image this time using disk memory
         codecs.Options.Load.DiskMemory = True
         image = codecs.Load(fileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1)

         ' make sure the image uses unmanaged memory
         If image.IsDiskMemory Then
            Console.WriteLine("This image uses disk memory")
         Else
            MessageBox.Show("This should not happen!!")
         End If

         ' Clean up
         image.Dispose()
         codecs.Dispose()
         RasterCodecs.Shutdown()
      End Sub
C#Copy Code
CodecsOptions.DiskMemory 
      public void DiskMemoryExample() 
      { 
         RasterCodecs.Startup(); 
         RasterCodecs codecs = new RasterCodecs(); 
         string fileName = @"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Image1.cmp"; 
         // first, load the image using the default 
         RasterImage image = codecs.Load(fileName); 
 
         // make sure the image uses conventional memory 
         if (image.IsConventionalMemory) 
            Console.WriteLine("This image uses conventional memory"); 
         else 
            MessageBox.Show("This should not happen!!"); 
 
         image.Dispose(); 
 
         // now, load the same image this time using disk memory 
         codecs.Options.Load.DiskMemory = true; 
         image = codecs.Load(fileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1); 
 
         // make sure the image uses unmanaged memory 
         if (image.IsDiskMemory) 
            Console.WriteLine("This image uses disk memory"); 
         else 
            MessageBox.Show("This should not happen!!"); 
 
         // Clean up 
         image.Dispose(); 
         codecs.Dispose(); 
         RasterCodecs.Shutdown(); 
      }

Remarks

When the value of this property is true, the image is stored in disk and not in conventional memory.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also