CM_RESULT (Compact 2013)

3/26/2014

The list of possible return codes for Connection Manager.

Syntax

typedef enum CM_RESULT{
CMRE_SUCCESS = 0,
CMRE_INVALID_REQUIREMENTS = CM_RESULT_BASE,
CMRE_INVALID_PREFERENCES,
CMRE_INVALID_SESSION,
CMRE_INVALID_CONNECTION,
CMRE_INVALID_CONNECTION_TYPE,
CMRE_INVALID_PARAMETER,
CMRE_INVALID_VERSION,
CMRE_INCONSISTENT_CONFIGURATION,
CMRE_INSUFFICIENT_BUFFER,
CMRE_CONNECTION_ITERATION_NOT_STARTED,
CMRE_NO_CONNECTIONS,
CMRE_HOST_ADDRESS_ITERATION_NOT_STARTED,
CMRE_NO_HOST_ADDRESSES,
CMRE_CONNECTION_ACQUIRE_FAILED,
CMRE_CONNECTION_ALREADY_ACQUIRED,
CMRE_CONNECTION_NOT_ACQUIRED,
CMRE_CONNECTION_RELEASE_FAILED,
CMRE_CONNECTION_ALREADY_EXISTS,
CMRE_CONNECTION_DOES_NOT_EXIST,
CMRE_NOT_ALLOWED,
CMRE_NO_NOTIFICATIONS,
CMRE_OUT_OF_MEMORY,
CMRE_PENDING,
CMRE_ACCESS_DENIED,
CMRE_NOT_SUPPORTED,
CMRE_NOT_IMPLEMENTED,
CMRE_UNEXPECTED,
CMRE_LAST
} CM_RESULT;

Elements

• CM_RESULT_BASE
  The first CM_RESULT value.

• CMRE_SUCCESS
  The operation completed successfully.

• CMRE_INVALID_REQUIREMENTS
  A requirements parameter is invalid.

• CMRE_INVALID_PREFERENCES
  A preferences parameter is invalid.

• CMRE_INVALID_SESSION
  The session is not valid.

• CMRE_INVALID_CONNECTION
  The name of the connection is not valid.

• CMRE_INVALID_CONNECTION_TYPE
  No loaded Connection Service Provider (CSP) handles the connection type.

• CMRE_INVALID_PARAMETER
  A parameter is invalid.

• CMRE_INVALID_VERSION
  The Connection Manager Common Constants of one or more of the structure parameters is not supported.

• CMRE_INCONSISTENT_CONFIGURATION
  The call was rejected because completing it would cause the configuration to be inconsistent.

• CMRE_INSUFFICIENT_BUFFER
  An output buffer is too small to contain the results of the call.

• CMRE_CONNECTION_ITERATION_NOT_STARTED
  Connection iteration has not been started with CmGetFirstCandidateConnection.

• CMRE_NO_CONNECTIONS
  There are no configured connections that meet the requirements and policies of the caller.

• CMRE_HOST_ADDRESS_ITERATION_NOT_STARTED
  Host address iteration has not been started with CmGetFirstIpAddr.

• CMRE_NO_HOST_ADDRESSES
  The host name could not be resolved using the connection

• CMRE_CONNECTION_ACQUIRE_FAILED
  The connection could not be established.

• CMRE_CONNECTION_ALREADY_ACQUIRED
  The connection has already been established.

• CMRE_CONNECTION_NOT_ACQUIRED
  The connection had not been obtained.

• CMRE_CONNECTION_RELEASE_FAILED
  An attempt to disconnect has not succeeded.

• CMRE_CONNECTION_ALREADY_EXISTS
  A connection of the same name already exists.

• CMRE_CONNECTION_DOES_NOT_EXIST
  The connection has not been established.

• CMRE_NOT_ALLOWED
  The requested operation is illogical and was rejected.

• CMRE_NO_NOTIFICATIONS
  There are no queued notifications.

• CMRE_OUT_OF_MEMORY
  Memory cannot be allocated to complete the operation.

• CMRE_PENDING
  The requested operation is in process.

• CMRE_ACCESS_DENIED
  The caller lacks sufficient privilege to perform the operation.

• CMRE_NOT_SUPPORTED
  A parameter is outside the supported range or domain.

• CMRE_NOT_IMPLEMENTED
  The operation has not been implemented.

• CMRE_UNEXPECTED
  An unexpected failure occurred.

• CMRE_LAST
  The last value.

Requirements

See Also

Reference

Connection Manager Common Enumerations