DrgAccessDraginfo: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;pdinfo (PDRAGINFO) - input:Pointer to the DRAGINFO structure. | ;pdinfo (PDRAGINFO) - input:Pointer to the [[DRAGINFO]] structure. | ||
==Returns== | ==Returns== | ||
| Line 14: | Line 14: | ||
==Remarks== | ==Remarks== | ||
This function is used by the target of a drag operation to access a | This function is used by the target of a drag operation to access a DRAGINFO structure. The address of the structure is passed in a drag message (DM_DRAGOVER, DM_DROP, or DM_DROPHELP). | ||
To release the structure, use the DrgFreeDraginfo function. | To release the structure, use the ''DrgFreeDraginfo'' function. | ||
==Example Code== | ==Example Code== | ||
Revision as of 05:52, 20 February 2020
This function provides access the drag information structure.
Syntax
DrgAccessDraginfo (pdinfo)
Parameters
- pdinfo (PDRAGINFO) - input
- Pointer to the DRAGINFO structure.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE - Successful completion.
- FALSE - Error occurred.
Remarks
This function is used by the target of a drag operation to access a DRAGINFO structure. The address of the structure is passed in a drag message (DM_DRAGOVER, DM_DROP, or DM_DROPHELP).
To release the structure, use the DrgFreeDraginfo function.
Example Code
This example uses the DrgAccessDraginfo function to make an existing drag information structure (created by the DrgAllocDraginfo function) available.
#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>
BOOL fSuccess; /* Indicate success or failure */
DRAGINFO Draginfo; /* Drag-information structure */
fSuccess = DrgAccessDraginfo(&Draginfo);
Related Functions
- DrgAllocDraginfo
- DrgDrag
- DrgFreeDraginfo
- DrgPushDraginfo