This function deletes a specified connection request, potentially dropping the physical connection.

HRESULT WINAPI ConnMgrReleaseConnection(
  HANDLE hConnection,
  LONG lCache);
); 

Parameters

hConnection

[in] Handle to the connection, returned from ConnMgrEstablishConnection.

lCache

The number of seconds to cache the connection before disconnection occurs. This parameter accepts values described in the following table.

Value	Description
A value greater than 1	The number of seconds to cache the connection before disconnection occurs.
1	The default cache time value, as specified by the HKEY_LOCAL_MACHINE\Comm\ConnMgr\Planner\Settings registry key. The CacheTime registry setting defines the default for non-exclusive connections and the VPNCacheTime registry setting defines the default for exclusive connections.
0	Disconnection occurs immediately (that is, the connection request is not cached).

Note   Some Windows Mobile 2002-based Smartphones ignore the specified value of this parameter and instead use the default value (60 seconds).

Return Values

Returns S_OK if successful, or an error code if the function call failed.

Remarks

The Connection Manager does not cache the following types of connections:

• Suspended connections
• Disconnected connections
• Connections without a DestId (that is, when the connection was provisioned using provisioning XML, a DestId was not specified)
• Fixed path connections (that is, a connection where the destination GUID is set to be an existing network connection managed using the Connection Manager)

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Connmgr.h.
Link Library: Cellcore.lib.

See Also

ConnMgrEstablishConnection

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.