CmCspCompareConnectionConfig (Compact 2013)

3/26/2014

Called by Connection Manager to determine if the type-specific configurations of two connections match.

Syntax

BOOL CmCspCompareConnectionConfig(
    __in_bcount(CM_CONNECTION_NAME_LENGTH) const WCHAR* szConnection1,
    __in CM_CONNECTION_TYPE TypeConnection2,
    __in_bcount(cbTypeSpecificConnection2) const BYTE* pTypeSpecificConnection2,
    __in DWORD cbTypeSpecificConnection2
);

Parameters

  • [in] szConnection1
    The connection name of the first configuration to compare.
  • [in] pTypeSpecificConnection2
    The second configuration.
  • [in] cbTypeSpecificConnection2
    The number of bytes in the pTypeSpecificConnection2 member.

Return Value

The function returns the following values.

Value

Description

TRUE.

The type specific configuration of the two connections is identical.

FALSE

The configurations are different, or the configurations could not be compared.

Remarks

This function is called by Connection Manager and processed by the Connection Service Provider.

The Connection Service Provider typically interprets pTypeSpecificConnection2 by casting it as its own type-specific information structure.

If the configurations match, Connection Manager applies the same state to the two connections. For example, if one connection is connected and there is a request to connect another that has the same type specific configuration, Connection Manager connects it without calling CmCspConnect.

Requirements

Header

cmcsp.h

See Also

Reference

Connection Service Provider Functions
CM_CONNECTION_TYPE
CmCspConnect

Other Resources

Connection Service Provider Reference