Jump to content

DrgAccessDraginfo

From EDM2
Revision as of 15:27, 2 November 2016 by Ak120 (talk | contribs) (Ak120 moved page OS2 API:PMI:DrgAccessDragInfo to DrgAccessDragInfo)

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);

Related Functions