CmGetConnectionSelectionResult (Compact 2013)

3/26/2014

This function returns the best result of the latest attempt to acquire a connection and an IP address pair.

Syntax

CM_RESULT CmGetConnectionSelectionResult(
__in CM_SESSION_HANDLE hSession
);

Parameters

• hSession
  [in] Pointer to a CM_SESSION_HANDLE.

Return Value

Value	Description
CMRE_SUCCESS	The operation completed successfully. At least one connection was successfully acquired during the last connection iteration. At least one IP address pair was found for the required destination host.
Other CM_RESULT value.	Any other result indicates the best result in an attempt to acquire connection and find IP address pair.

Remarks

This function is used by applications that depend on Winsock or WinInet for connection selection, but need visibility into the Connection Manager result encountered by those APIs during connection selection. Call this function only after the Winsock or WinInet API returns.

This function requires that you first call CmGetFirstCandidateConnection and CmGetNextCandidateConnection.

Requirements

Header	cmnet.h
Library	cmnet.lib

See Also

Reference

Connection Manager Connectivity Functions
CM_RESULT
CM_SESSION_HANDLE
CmGetFirstCandidateConnection
CmGetNextCandidateConnection