Associates a service object name with a client-side API handle.
DWORD NMSAPI dispSetHandleValueEx (unsigned hd, unsigned value, char *name)
|
Argument |
Description |
|
hd |
Handle returned by dispCreateHandle. |
|
value |
Value to associate with the given handle. |
|
name |
Pointer to a name to associate with the object. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_INVALID_HANDLE |
Specified hd is not valid. |
|
CTAERR_NOT_INITIALIZED |
Natural Access is not initialized. |
dispSetHandleValueEx associates a name and server-side value with an object handle created by the dispatcher. value can be any value that fits into an unsigned integer (pointer or index). dispSetHandleValueEx is typically used to map API (client) side object handles to Natural Access context handles and service (server) side object handles. This is useful for services, such as the Voice Message service, that create multiple sets of objects associated with the Natural Access context. name is used for service object sharing.
The value can be retrieved by using dispGetHandleValueEx and can also be set directly in the call to dispCreateHandle.
dispAttachHandle, dispDestroyHandle, dispFindHandle, dispFindHandleByName, dispGetHandleValue, dispSetHandleValue