CmCspGetConnectionConfig (Compact 2013)

  • Article

3/26/2014

This function is called by Connection Manager to retrieve a connection configuration.

Syntax

CM_RESULT CmCspGetConnectionConfig(
    __in_bcount(CM_CONNECTION_NAME_LENGTH) const WCHAR* szConnection,
    __inout_bcount(*pcbTypeSpecificInfo) BYTE* pTypeSpecificInfo,
    __inout DWORD* pcbTypeSpecificInfo
);

Parameters

  • [in] szConnection
    The connection name.

  • [in] pTypeSpecificInfo
    [in] A pointer to a storage area to place the output.

    [out] A pointer to a structure that is specific to the Connection Service Provider.

  • [in] pcbTypeSpecificInfo
    [in] The number of bytes allocated to the pTypeSpecificInfo structure.

    [out] A pointer to the number of bytes required to hold the pTypeSpecificInfo structure, if the input parameter was not big enough.

Return Value

The following table shows the possible return values.

Value

Description

CMRE_SUCCEEDED

The call succeeded.

CMRE_INVALID_CONNECTION

The connection does not exist.

CMRE_INVALID_PARAMETER

One or more of input or output parameters other than the name of the connection are invalid.

CMRE_INSUFFICIENT_BUFFER

pcbTypeSpecificInfo was not large enough to contain the pTypeSpecificInfo. The output value of pcbTypeSpecificInfo is a pointer to the minimum size for pTypeSpecificInfo.

CMRE_UNEXPECTED

Any other failure to delete the connection.

Requirements

Header

cmcsp.h

See Also

Reference

Connection Service Provider Functions