DrgDeleteDraginfoStrHandles
This function deletes each unique string handle in a DRAGINFO structure.
Syntax
DrgDeleteDraginfoStrHandles(pDraginfo)
Parameters
- pDraginfo (PDRAGINFO) - input
- Pointer to the DRAGINFO structure that contains string handles to delete.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE - Successful completion.
- FALSE - Error occurred.
Remarks
Using this function is equivalent to calling the DrgDeleteStrHandle function for each unique string in a DRAGINFO structure. This function must be called by the target of a direct manipulation operation either:
- After processing a DM_DROPHELP message
or
- After completing the direct manipulation operation begun as a result of a DM_DROP message.
Errors
Possible returns from WinGetLastError:
- PMERR_INVALID_PARAMETERS (0x1208)
- An application parameter value is invalid for its converted PM type. For example: a 4-byte value outside the range -32 768 to +32 767 cannot be converted to a SHORT, and a negative number cannot be converted to a ULONG or USHORT.
Example Code
#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>
BOOL fSuccess; /* Indicate success or failure */
DRAGINFO Draginfo; /* DRAGINFO structure containing string */
/* handles to delete */
fSuccess = DrgDeleteDraginfoStrHandles (&Draginfo);