MdispSelectWindow (Mil function description)

Synopsis

 

Select an image buffer to display in a user-defined window.

Syntax

void MdispSelectWindow ( 
    MIL_ID  DisplayId ,     MIL_ID ImageBufId, 
    HWND ClientWindowHandle 
)

Description

This function outputs the content of the specified image buffer to the specified user-defined window, using the specified MIL display.

If the specified image buffer is smaller in size than the target window size, the border outside the image is not modified. If the specified buffer is larger in size than the target window, the right and bottom portion of the buffer, the part that exceeds the window, is not displayed.

You can control the displayed area using MdispControl(), MdispPan(), or MdispZoom(). For example, you can center the selected image in the display using MdispControl() with M_CENTER_DISPLAY.

To remove an image buffer selected to the display using MdispSelectWindow(), you can use MdispSelectWindow() with M_NULL. This leaves the associated window open but leaves it blank.

This function is valid only in a Windows environment.

This function does not support remote displays (MdispAlloc() with M_REMOTE_DISPLAY).

 

Parameters

 

  DisplayId

     Specifies the identifier of the display.

ImageBufId

     Specifies the image buffer to display. To be displayable, this buffer must be an image buffer that has an M_IMAGE + M_DISP attribute.

     This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

     Set this parameter to M_NULL to stop displaying the currently selected image buffer on the specified display.

 ClientWindowHandle

      Specifies the handle of the user-defined window or child window. This window must have been created with the Windows API functions. If this parameter is set to zero, this function behaves like MdispSelect().

      Set this parameter to M_NULL if the ImageBufId parameter is set to M_NULL.

 

Compilation information

 

Header	Include windows.h; mil.h (windows.h must be included first).
Library	Use mil.lib.
DLL	Requires mil.dll; mildisplay.dll.