Share via


WNetCancelConnection2

This function breaks an existing network connection.

DWORD WNetCancelConnection2(
LPTSTR lpName, 
DWORD dwFlags, 
BOOL fForce );

Parameters

  • lpName
    [in] Long pointer to a null-terminated string that specifies the name of either the local name or the remote network resource to disconnect.

  • dwFlags
    [in] Specifies a bitmask for the connection type. The following values are defined:

    Value Description
    0 The connection to the remote server is broken; however, no persistent information about the connection is updated.
    CONNECT_UPDATE_PROFILE The system is updated with the information that this is no longer a persistent connection. Disconnecting resources using remote names has no effect on persistent connections.
  • fForce
    [in] Boolean that specifies whether the disconnection should occur even if there are open files or jobs on the connection. If this parameter is FALSE, the function fails if there are open files or jobs.

Return Values

ERROR_SUCCESS indicates success. An error value indicates failure. To get extended error information, call GetLastError. Possible GetLastError values are described in the following table.

Value Description
ERROR_NOT_CONNECTED The name specified by the lpName parameter is not a local or remote network resource, or the system is not currently connected to the device specified by the parameter.
ERROR_OPEN_FILES There are open files, and the fForce parameter is FALSE.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Winnetwk.h   Redir.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.