L_DestroyZoomView

#include "l_bitmap.h"

L_LTZMV_API L_INT L_DestroyZoomView(hWnd, uIndex)

HWND hWnd;

/* handle to a window */

L_UINT uIndex;

/* index of the zoomed view to be destroyed */

Destroys the specified Zoom View, and releases all resources associated with it. Call this function before destroying the window.

Parameter

Description

hWnd

Handle to a window.

uIndex

Index of the zoomed view to be destroyed. This is a zero-based index.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

When a zoomed view is no longer needed, call the L_DestroyZoomView function to stop the specified Zoom View procedure and to detach it from the window handle.

You must call this function for each Zoom View you have created before destroying the window with which the Zoom Views are associated.

If you need to destroy all the zoomed views that are attached to a specified window, destroy them from the last Zoom View to the first Zoom View. For example, if you have five Zoom Views associated with the specified window you need to do the following:

            L_UINT uCount,i;
            L_GetZoomViewsCount(hWnd,&uCount);
            
            for(i=0; i < uCount; ++i) 
            {
               L_DestroyZoomView(hWnd,uCount-i-1); 
            }

Required DLLs and Libraries

LTZMV

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

L_WindowHasZoomView, L_CreateZoomView, L_GetZoomViewProps, L_UpdateZoomView, L_GetZoomViewsCount

Topics:

Using the Zoom View

 

Raster Image Functions: Displaying Images

 

Using the Magnifying Glass

Example

 L_INT DestroyZoomViewExample(HWND hWnd)
{
   L_INT nRet;
   L_UINT uCount, i;
   
   if(L_WindowHasZoomView (hWnd))
   {
      nRet = L_GetZoomViewsCount (hWnd,&uCount);
      if(nRet != SUCCESS)
         return nRet;

      for(i=0; i < uCount;++i)
      {
         nRet = L_DestroyZoomView (hWnd,uCount-i-1);
         if(nRet != SUCCESS)
            return nRet;
      }
   }
   else
      return FALSE; 
   return SUCCESS;
}