DrgAccessDraginfo: Difference between revisions
m Martini moved page OS2 API:DrgAccessDragInfo to OS2 API:PMI:DrgAccessDragInfo |
No edit summary |
||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
This function | This function provuides access the drag information structure. | ||
==Syntax== | ==Syntax== | ||
#define INCL_WINSTDDRAG | #define INCL_WINSTDDRAG | ||
#include <os2.h> | #include <os2.h> | ||
PDRAGINFO pdinfo; /* Pointer to the DRAGINFO structure. */ | PDRAGINFO pdinfo; /* Pointer to the DRAGINFO structure. */ | ||
BOOL rc; /* Success indicator. */ | BOOL rc; /* Success indicator. */ | ||
rc = DrgAccessDraginfo(pdinfo); | rc = DrgAccessDraginfo(pdinfo); | ||
==Parameters== | ==Parameters== | ||
pdinfo (PDRAGINFO) - input | ;pdinfo (PDRAGINFO) - 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. | |||
#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | #define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */ | ||
#include <os2.h> | #include <os2.h> | ||
| Line 59: | Line 37: | ||
==Related Functions== | ==Related Functions== | ||
* DrgAllocDraginfo | *[[DrgAllocDraginfo]] | ||
* DrgDrag | *[[DrgDrag]] | ||
* DrgFreeDraginfo | *[[DrgFreeDraginfo]] | ||
* DrgPushDraginfo | *[[DrgPushDraginfo]] | ||
[[Category: | [[Category:Drg]] | ||
Revision as of 15:26, 2 November 2016
Description
This function provuides access the drag information structure.
Syntax
#define INCL_WINSTDDRAG #include <os2.h> PDRAGINFO pdinfo; /* Pointer to the DRAGINFO structure. */ BOOL rc; /* Success indicator. */ rc = 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);