DrgAccessDraginfo: Difference between revisions
m Ak120 moved page OS2 API:PMI:DrgAccessDragInfo to DrgAccessDragInfo |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This function provides access the drag information structure. | |||
This function | |||
==Syntax== | ==Syntax== | ||
DrgAccessDraginfo (pdinfo) | |||
==Parameters== | ==Parameters== | ||
;pdinfo (PDRAGINFO) - input | ;pdinfo (PDRAGINFO) - input:Pointer to the DRAGINFO structure. | ||
:Pointer to the DRAGINFO structure. | |||
==Returns== | ==Returns== | ||
| Line 28: | Line 20: | ||
==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. | ||
<code> | |||
#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | #define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | ||
#include <os2.h> | #include <os2.h> | ||
| Line 35: | Line 28: | ||
fSuccess = DrgAccessDraginfo(&Draginfo); | fSuccess = DrgAccessDraginfo(&Draginfo); | ||
</code> | |||
==Related Functions== | ==Related Functions== | ||
* | *DrgAllocDraginfo | ||
* | *DrgDrag | ||
* | *DrgFreeDraginfo | ||
* | *DrgPushDraginfo | ||
[[Category:Drg]] | [[Category:Drg]] | ||
Revision as of 23:49, 25 February 2017
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