Share via

CmCspSetDataActivityState (Compact 2013)

  • Article

3/26/2014

This function is called by Connection Manager after an application calls CmSetDataActivityState.

Syntax

CM_RESULT CmCspSetDataActivityState(
    __in_bcount(CM_CONNECTION_NAME_LENGTH) const WCHAR* szConnection,
    __in CM_DATA_ACTIVITY_STATE  State,
    __in ULONG  DormantCancelOnActivityMs);

Parameters

  • [in] szConnection
    The length of the connection name.
  • [in] State
    The current state of the connection.
  • [in] DormantCancelOnActivityMs
    If State is CMDS_DORMANT, this parameter indicates how long the Connection Service Provider driver must wait before going dormant. Any send activity must cancel the dormancy request, because another application is still actively using the connection.

Return Value

The following table shows the possible return values.

Value

Description

CMRE_SUCCEEDED

Type-specific information has been successfully retrieved.

CMRE_INVALID_CONNECTION

The connection does not exist.

CMRE_NOT_SUPPORTED

The API is not supported by the Connection Service Provider.

CMRE_UNEXPECTED

An unexpected failure occurred.

Requirements

Header

cmcsp.h

See Also

Reference

Connection Service Provider Functions
CM_DATA_ACTIVITY_STATE
CmSetDataActivityState

Other Resources

Connection Service Provider Reference