dispSetHandleValue

Associates a value with a dispatcher-created handle.

Prototype

DWORD dispSetHandleValue (unsigned hd, unsigned value)

Argument

Description

hd

Handle returned by dispCreateHandle.

value

Value to associate with a given handle.


Return values

Return value

Description

SUCCESS

 

CTAERR_INVALID_HANDLE

Specified hd is not valid.


Details

dispSetHandleValue associates the specified value with the dispatcher-created handle. The value can be any value that fits into an unsigned integer (pointer or index). dispSetHandleValue is typically used for managing the mapping of API (client) side user handles to context handles and service (server) side handles. This is useful for services, such as the Voice Message service, that create another set of objects that are also associated with the context.

The value can be retrieved by using dispGetHandleValue and can also be set directly in the call to dispCreateHandle.

See also

dispAttachHandle, dispDestroyHandle, dispFindHandle, dispFindHandleByName, dispGetHandleValueEx, dispSetHandleValueEx