DrgAccessDraginfo: Difference between revisions

Latest revision as of 23:56, 14 May 2025

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

@@ Line 1: / Line 1: @@
-DrgAccessDraginfo
+This function provides access the drag information structure.
-Access the drag information
-PMDRAG.DLL 	os2.h
+==Syntax==
+ DrgAccessDraginfo (pdinfo)
+==Parameters==
+;pdinfo (P[[DRAGINFO]]) - input:Pointer to the [[DRAGINFO]] structure.
-Syntax
+==Returns==
-BOOL DrgAccessDraginfo (PDRAGINFO pdinfo);
+;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]]).
-Description
+To release the structure, use the ''[[DrgFreeDraginfo]]'' function.
-This function allows you to DRAGINFO information structure.
+==Example Code==
+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 */
+ #include <os2.h>
+ BOOL      fSuccess;      /* Indicate success or failure          */
+ DRAGINFO  Draginfo;      /* Drag-information structure           */
+ fSuccess = DrgAccessDraginfo(&Draginfo);
+</pre>
+==Related Functions==
+*[[DrgAllocDraginfo]]
+*[[DrgDrag]]
+*[[DrgFreeDraginfo]]
+*[[DrgPushDraginfo]]
+[[Category:Drg]]