Retrieves the value associated with the given API handle.
DWORD dispGetHandleValue (unsigned hd, CTAHD *ctahd, unsigned *value)
|
Argument |
Description |
|
hd |
Handle returned by dispCreateHandle. |
|
ctahd |
Pointer to a handle. |
|
value |
Pointer to the returned value. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_INVALID_HANDLE |
The specified hd is not valid. |
|
CTAERR_NOT_INITIALIZED |
Natural Access is not initialized. |
dispGetHandleValue retrieves the value that was associated with the given API handle either when it was created using dispCreateHandle or when it was explicitly set using dispSetHandleValue. This value can be any unsigned integer. This 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.
dispAttachHandle, dispDestroyHandle, dispFindHandle, dispFindHandleByName, dispGetHandleValueEx, dispSetHandleValueEx