DdeFreeDataHandle

  BOOL DdeFreeDataHandle(hData)    
  HDDEDATA hData; /* handle of global memory object */

The DdeFreeDataHandle function frees a global memory object and deletes the data handle associated with the object.

Parameters

hData

Identifies the global memory object to be freed. This handle must have been created by a previous call to the DdeCreateDataHandle function or returned by the DdeClientTransaction function.

Return Value

The return value is nonzero if the function is successful. Otherwise, it is zero.

Errors

Use the DdeGetLastError function to retrieve the error value, which may be one of the following:

DMLERR_INVALIDPARAMETER
DMLERR_NO_ERROR

Comments

An application must call DdeFreeDataHandle under the following circumstances:

To free a global memory object that the application allocated by calling the DdeCreateDataHandle function if the object's data handle was never passed by the application to another Dynamic Data Exchange Management Library (DDEML) function

To free a global memory object that the application allocated by specifying the HDATA_APPOWNED flag in a call to the DdeCreateDataHandle function

To free a global memory object whose handle the application received from the DdeClientTransaction function

The system automatically frees an unowned object when its handle is returned by a dynamic data exchange (DDE) callback function or used as a parameter in a DDEML function.

See Also

DdeAccessData, DdeCreateDataHandle