DrgAccessDraginfo: Difference between revisions
mNo edit summary |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;pdinfo ( | ;pdinfo (P[[DRAGINFO]]) - input:Pointer to the [[DRAGINFO]] structure. | ||
==Returns== | ==Returns== | ||
;rc (BOOL) - returns | ;rc ([[BOOL]]) - returns | ||
:Success indicator. | :Success indicator. | ||
:: | :;TRUE | ||
:: | ::Successful completion. | ||
:;FALSE | |||
::Error occurred. | |||
==Remarks== | ==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). | 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== | ||
This example uses the DrgAccessDraginfo function to make an existing drag information structure (created by the DrgAllocDraginfo function) available. | This example uses the DrgAccessDraginfo function to make an existing drag information structure (created by the DrgAllocDraginfo function) available. | ||
< | <pre> | ||
#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | #define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | ||
#include <os2.h> | #include <os2.h> | ||
| Line 28: | Line 30: | ||
fSuccess = DrgAccessDraginfo(&Draginfo); | fSuccess = DrgAccessDraginfo(&Draginfo); | ||
</ | </pre> | ||
==Related Functions== | ==Related Functions== | ||
*DrgAllocDraginfo | *[[DrgAllocDraginfo]] | ||
*DrgDrag | *[[DrgDrag]] | ||
*DrgFreeDraginfo | *[[DrgFreeDraginfo]] | ||
*DrgPushDraginfo | *[[DrgPushDraginfo]] | ||
[[Category:Drg]] | [[Category:Drg]] | ||
Latest revision as of 23:56, 14 May 2025
This function provides access the drag information structure.
Syntax
DrgAccessDraginfo (pdinfo)
Parameters
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);