CmGetConnectionDetailsByName (Compact 2013)

3/26/2014

This function retrieves a CM_CONNECTION_DETAILS structure that contains the current state of a connection. The szName of this structure is a key specifying the connection to query.

Syntax

CM_RESULT CmGetConnectionDetailsByName(
__in const WCHAR* pszConnection,
__inout_bcount(*pcbDetails) CM_CONNECTION_DETAILS* pDetails,
__inout DWORD* pcbDetails
);

Parameters

• pszConnection
  [in] A pointer to the connection name as provided by CmEnumConnectionsConfig.

• pDetails
  [in] A pointer to a CM_CONNECTION_DETAILS structure.

  The Version and szName parameters of this structure must be initialized. All other fields may be left uninitialized.

  [out] A pointer to a CM_CONNECTION_DETAILS structure.

  This structure is populated with the details of the connection.

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

  [out] The size, in bytes, of the pDetails structure.

Return Value

Value	Description
CMRE_SUCCESS	The operation completed successfully.
CMRE_INSUFFICIENT_BUFFER	The pDetailsoutput buffer, as described by pcbDetails, is too small to hold the connection details. The required size is returned in pcbDetails.
CMRE_INVALID_CONNECTION	The connection name in szName is not valid.
CMRE_INVALID_PARAMETER	A parameter is invalid.
CMRE_UNEXPECTED	An unexpected failure occurred.

Requirements

Header	cmnet.h
Library	cmnet.lib

See Also

Reference

Connection Manager Status and Notification Functions
CM_CONNECTION_DETAILS