Share via


CmRegisterNotificationsListener (Compact 2013)

3/26/2014

This function registers a listener for notifications.

Syntax

CM_RESULT CmRegisterNotificationsListener(
__in_bcount(cbRegistration) CM_NOTIFICATIONS_LISTENER_REGISTRATION* pRegistration,
__in DWORD cbRegistration,
__out CM_NOTIFICATIONS_LISTENER_HANDLE* phListener
);

Parameters

  • pRegistration
    [in] Pointer to the notifications listener registration structure. pRegistration must not be null. It contains a version number, a registration-entry count, and an array of one or more registration entries. For more information, see CM_NOTIFICATIONS_LISTENER_REGISTRATION.
  • cbRegistration
    [in] Byte count of the registration structure pointed to by pRegistration.
  • phListener
    [out] A pointer to the handle of a notification listener. phListener must not be null.

Return Value

Value

Description

CMRE_SUCCESS

The operation completed successfully.

CMRE_INVALID_VERSION

The version number is invalid.

CMRE_INVALID_PARAMETER

At least one of the parameters are not valid.

CMRE_OUT_OF_MEMORY

Memory can not be allocated to complete the operation.

CMRE_UNEXPECTED

An unexpected failure occurred.

Requirements

Header

cmnet.h

Library

cmnet.lib

See Also

Reference

Connection Manager Status and Notification Functions