Checks or cancels the notify input state status.
- Parameters:
-
| [in] | handle | Valid handle returned by SM_Open(). |
| [in] | cancel | Non zero value indicates the current notify operation should be canceled. |
- Return values:
-
| 2 | Last input read failed. Will try again (non-terminal). |
| 1 | Input state has changed. 'Values' paramter to SM_NotifyOnInputChange() now contains valid input state. |
| 0 | No change in inputs detected. |
| -1 | Invalid SeaMAX handle. |
| -2 | There is no currently outstanding NotifyOnInputChange request started. You must call SM_NotifyOnInputChange() first. |
| -3 | Could not read inputs. Parameters may be incorrect or the device may not be reachable, present, or may be busy. |
| -4 | Read request has been canceled. |
This function allows the caller to check on the status of a notify request that was previously issued. Also, SM_NotifyInputState allows the caller to cancel an outstanding request. See
SM_NotifyOnInputChange() for more details.
- Note:
- One or more of the return values are non-terminal. Non-terminal error codes indicates that there was a problem which did not force a cancelation of the request, and that the request will continue until completed or until canceled by the caller.
- See also:
- SM_NotifyOnInputChange()
