DdeFreeStringHandle function (ddeml.h)

Frees a string handle in the calling application.

Syntax

BOOL DdeFreeStringHandle(
  [in] DWORD idInst,
  [in] HSZ   hsz
);

Parameters

[in] idInst

Type: DWORD

The application instance identifier obtained by a previous call to the DdeInitialize function.

[in] hsz

Type: HSZ

A handle to the string handle to be freed. This handle must have been created by a previous call to the DdeCreateStringHandle function.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

An application can free string handles it creates with DdeCreateStringHandle but should not free those that the system passed to the application's Dynamic Data Exchange (DDE) callback function or those returned in the CONVINFO structure by the DdeQueryConvInfo 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

See also

CONVINFO

Conceptual

DdeCmpStringHandles

DdeCreateStringHandle

DdeInitialize

DdeKeepStringHandle

DdeQueryConvInfo

DdeQueryString

Dynamic Data Exchange Management Library

Reference