DdeSetUserHandle function

Associates an application-defined value with a conversation handle or a transaction identifier. This is useful for simplifying the processing of asynchronous transactions. An application can use the DdeQueryConvInfo function to retrieve this value.

Syntax


BOOL WINAPI DdeSetUserHandle(
  _In_  HCONV hConv,
  _In_  DWORD id,
  _In_  DWORD_PTR hUser
);

Parameters

hConv [in]

Type: HCONV

A handle to the conversation.

id [in]

Type: DWORD

The transaction identifier to associate with the value specified by the hUser parameter. An application should set this parameter to QID_SYNC to associate hUser with the conversation identified by the hConv parameter.

hUser [in]

Type: DWORD_PTR

The value to be associated with the conversation handle.

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:

DMLERR_DLL_NOT_INITIALIZED
DMLERR_INVALIDPARAMETER
DMLERR_NO_ERROR
DMLERR_UNFOUND_QUEUE_ID

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ddeml.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
DdeQueryConvInfo
Conceptual
Dynamic Data Exchange Management Library

 

 

Community Additions

ADD
Show:
© 2015 Microsoft