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: @@
+This function provides access the drag information structure.
-==Description==
-This function allows you to DRAGINFO information structure.
-DrgAccessDraginfo
-Access the drag information
-PMDRAG.DLL 	os2.h
 ==Syntax==
-  BOOL DrgAccessDraginfo (PDRAGINFO pdinfo);
+  DrgAccessDraginfo (pdinfo)
----
- #define INCL_WINSTDDRAG
- #include <os2.h>
- PDRAGINFO    pdinfo;  /*  Pointer to the DRAGINFO structure. */
- BOOL         rc;      /*  Success indicator. */
- rc = DrgAccessDraginfo(pdinfo);
 ==Parameters==
-pdinfo (PDRAGINFO) - input
+;pdinfo (P[[DRAGINFO]]) - input:Pointer to the [[DRAGINFO]] structure.
-* Pointer to the DRAGINFO structure.
-rc (BOOL) - returns
-* Success indicator.
-    TRUE
-        Successful completion. FALSE
-        Error occurred.
 ==Returns==
-rc (BOOL) - returns
+;rc ([[BOOL]]) - returns
+:Success indicator.
-Success indicator.
+:;TRUE
+::Successful completion.
-    TRUE
+:;FALSE
-        Successful completion.
+::Error occurred.
- 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).
+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==
- 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.
+<pre>
   #define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
   #include <os2.h>
@@ Line 59: / Line 30: @@
   fSuccess = DrgAccessDraginfo(&Draginfo);
+</pre>
 ==Related Functions==
-* DrgAllocDraginfo
+*[[DrgAllocDraginfo]]
-* DrgDrag
+*[[DrgDrag]]
-* DrgFreeDraginfo
+*[[DrgFreeDraginfo]]
-* DrgPushDraginfo
+*[[DrgPushDraginfo]]
+[[Category:Drg]]