PhCancelDrag()

Cancel a drag operation

Synopsis:

int PhCancelDrag(
        PhRid_t rid,
        unsigned input_group,
        unsigned flags );

Arguments:

rid: A PhRid_t that must match the rid passed to the PhInitDrag() that initiated the drag operation you want to cancel.
flags: Must be 0.
input_group: An input-group value that must match the input_group passed to the PhInitDrag() that initiated the drag operation you want to cancel.

Library:

ph

Description:

This function cancels a drag. The application still collects a Ph_EV_DRAG event with a subtype of PhEV_DRAG_COMPLETE that describes the results of the operation. You can inspect the button_state member of the event PhDragEvent_t data structure to determine whether the PhCancelDrag() call or a button release caused the operation to complete.

Returns:

A non-negative number.: Successful completion.
-1: An error occurred.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PhBitmapCursorDescription_t, PhCharacterCursorDescription_t, PhDragEvent_t, PhEvent_t, PhGetData(), PhDim_t, PhInitDrag() PhPoint_t, PhRect_t, PhTranslateRect()

“Dragging” in the Events chapter of the Photon Programmer's Guide