Admin Production ni-theme
Current Publication

GetDragAndDropData

LabWindows/CVI

GetDragAndDropData

int GetDragAndDropData (char ***fileList, Point *mouseCoordinates);

Purpose

This function obtains the data associated with the current drag–and–drop notification.

You can call this function only from the panel callback at the time that you receive the EVENT_FILESDROPPED event.

(Linux) This function is not supported.

Parameters

Output
Name Type Description
fileList char ** An array of strings indicating the paths of the received files.

The length of the array is one element greater than the number of received files. The last element is 0.

When you no longer need them, free each string and the array with the free function. For an example of how to free this data structure, refer to the help for the MultiFileSelectPopup function.
mouseCoordinates Point A Point structure indicating the position at which the files were dropped, relative to the top–left corner of the panel.

typedef struct

{
int x;
int y;
} Point;

Return Value

Name Type Description
status int The status code that the function returns.

0 indicates success.

A negative value indicates an error.

This function may return a Programmer's Toolbox or UI Library error–code. Call GetGeneralErrorString to obtain a text description of the error.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 2009 and later

Example

Refer to toolbox\msgdemo.cws for an example of using the GetDragAndDropData function.