DdeFreeDataHandle function (ddeml.h)

Article
02/22/2024

Frees a Dynamic Data Exchange (DDE) object and deletes the data handle associated with the object.

Syntax

BOOL DdeFreeDataHandle(
  [in] HDDEDATA hData
);

Parameters

[in] hData

Type: HDDEDATA

A handle to the DDE 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

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

The DdeGetLastError function can be used to get the error code, which can be one of the following values:

Remarks

An application must call DdeFreeDataHandle under the following circumstances:

To free a DDE 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 DDE object that the application allocated by specifying the HDATA_APPOWNED flag in a call to DdeCreateDataHandle
To free a DDE object whose handle the application received from the DdeClientTransaction function

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

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ddeml.h (include Windows.h)
Library	User32.lib
DLL	User32.dll