Public Function GetOverlayImage( _
   ByVal index As Integer, _
   ByVal mode As RasterGetSetOverlayImageMode _
) As RasterImage

Visual Basic (Usage)	Copy Code
Dim instance As RasterImage Dim index As Integer Dim mode As RasterGetSetOverlayImageMode Dim value As RasterImage   value = instance.GetOverlayImage(index, mode)

public RasterImage GetOverlayImage( 
   int index,
   RasterGetSetOverlayImageMode mode
)

public: RasterImage* GetOverlayImage( 
   int index,
   RasterGetSetOverlayImageMode mode
) 

public:
RasterImage^ GetOverlayImage( 
   int index,
   RasterGetSetOverlayImageMode mode
) 

Parameters

index

The index of the overlay being retrieved. This index is zero-based and should be less or equal than MaxOverlays.

mode

Determines how to retreive the image, possible values are:

Mode	Description
RasterGetSetOverlayImageMode.Copy	A copy of the overlay image is retrieved from the overlay list.
RasterGetSetOverlayImageMode.NoCopy	The actual overlay image is retrieved. No copy is made. You should be careful when modifying the returned overlay image because you can modify/invalidate the entry in the overlay bitmap list.
RasterGetSetOverlayImageMode.Move	The actual overlay image is retrieved. The image is also removed from the overlay list. This is recommended over RasterGetSetOverlayImageMode.NoCopy.

Return Value

This method is available in the (Document/Medical only) Toolkits.

This method can be used to get a copy of the overlay image (RasterGetSetOverlayImageMode.Copy) or to get the image without making a copy (RasterGetSetOverlayImageMode.NoCopy or RasterGetSetOverlayImageMode.Move).

The quickest way to get the overlay image is to avoid making a copy. For more information on using RasterGetSetOverlayImageMode.NoCopy, refer to the "Remarks" section of SetOverlayImage.

For more information, refer to Overlay Overview.

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

Reference