Retrieves all information associated with a client-side API handle, including context handle, server-side service object handle, service object name, and service identifier.
DWORD NMSAPI dispGetHandleValueEx (unsigned hd, CTAHD *ctahd, unsigned *svcid, unsigned *value, char *name)
|
Argument |
Description |
|
hd |
Handle returned by dispCreateHandle. |
|
ctahd |
Pointer to a handle. |
|
svcid |
Pointer to the identifier of the service associated with the handle. |
|
value |
Pointer to receive the returned value. |
|
name |
Pointer to a name associated with the object (with dispSetHandleValueEx). |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_INVALID_HANDLE |
The specified hd is not valid. |
|
CTAERR_NOT_INITIALIZED |
Natural Access is not initialized. |
dispGetHandleValueEx retrieves the information in the dispatcher's internal handle mapping table that is associated with the passed-in client-side handle. The information returned is:
The associated context handle
The service ID of the service that created the handle
The server-side object handle
The service object name
value can be any unsigned integer. value is typically a number that represents a server-side object and can be used as an index into a context-specific array by the service. name is used for service object sharing.
dispAttachHandle, dispCreateHandle, dispDestroyHandle, dispFindHandle, dispFindHandleByName, dispGetHandleValue, dispSetHandleValue