DrgAccessDraginfo

Description

This function allows you to DRAGINFO information structure.

Access the drag information.

DLL

PMDRAG.DLL

os2.h

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.

rc (BOOL) - returns

• Success indicator.

   TRUE
       Successful completion. FALSE
       Error occurred.

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