Admin Production ni-theme
Current Publication

DisableExtendedMouseEvents

LabWindows/CVI

DisableExtendedMouseEvents

int DisableExtendedMouseEvents (int panel, int ctrl);

Purpose

Note Note  This function has been superseded by the following built-in LabWindows/CVI events: EVENT_MOUSE_POINTER_MOVE, EVENT_LEFT_CLICK_UP, and EVENT_RIGHT_CLICK_UP. Use this function if you have enabled extended events to get event information when a user releases the left or right mouse buttons outside of a LabWindows/CVI panel.

Stops a control from receiving the extended mouse events. Call this function after you call EnableExtendedMouseEvents.

Parameters

Input
Name Type Description
panel int The specifier for a particular panel that is currently in memory.

You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
ctrl int The ID of the control for which to disable extended mouse events.

The ID is the defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by NewCtrl or DuplicateCtrl.

Return Value

Name Type Description
status int Returns zero if the extended mouse events were disabled for the control, or a negative error code if the function failed.

If extended mouse events have not been enabled for the control by a previous call to EnableExtendedMouseEvents, then the error code UIEInvalidControlType (–45) is returned.

The possible negative error codes are:

–1 to –999 A User Interface Library error code. (constants are available in userint.h)

A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later