CmGetNotification (Compact 2013)
3/26/2014
This function retrieves the next queued notification.
Syntax
CM_RESULT CmGetNotification(
__in CM_NOTIFICATIONS_LISTENER_HANDLE hListener,
__inout_bcount_opt(*pcbNotification) CM_NOTIFICATION* pNotification,
__inout DWORD* pcbNotification
);
Parameters
- hListener
[in] A CM_NOTIFICATIONS_LISTENER_HANDLE.
pNotification
[inout] A pointer to a CM_NOTIFICATION structure.[in] The Version parameter of this structure must be initialized. All other fields may be left uninitialized.
[out] This structure is populated with the details of the connection.
pcbNotification
[in] A pointer to a storage area to place the output.[out] The size, in bytes, of the pNotification structure.
Return Value
Value |
Description |
|---|---|
CMRE_SUCCESS |
The operation completed successfully. |
CMRE_INSUFFICIENT_BUFFER |
The pNotification output buffer is too small to contain the results of the call. The required size is returned in pcbNotification. |
CMRE_NO_NOTIFICATIONS |
There are no queued notifications. |
CMRE_INVALID_PARAMETER |
A parameter is invalid. |
CMRE_UNEXPECTED |
An unexpected failure occurred. |
Requirements
Header |
cmnet.h |
Library |
cmnet.lib |