Função WNetCancelConnection2W (winnetwk.h)

Artigo
08/27/2023

A função WNetCancelConnection2 cancela uma conexão de rede existente. Você também pode chamar a função para remover conexões de rede lembradas que não estão conectadas no momento.

A função WNetCancelConnection2 substitui a função WNetCancelConnection .

Sintaxe

DWORD WNetCancelConnection2W(
  [in] LPCWSTR lpName,
  [in] DWORD   dwFlags,
  [in] BOOL    fForce
);

Parâmetros

[in] lpName

Ponteiro para uma cadeia de caracteres terminada em nulo constante que especifica o nome do dispositivo local redirecionado ou do recurso de rede remota do qual se desconectar.

Se esse parâmetro especificar um dispositivo local redirecionado, a função cancelará apenas o redirecionamento de dispositivo especificado. Se o parâmetro especificar um recurso de rede remota, todas as conexões sem dispositivos serão canceladas.

[in] dwFlags

Tipo de conexão. Os valores a seguir são definidos.

Valor	Significado
0	O sistema não atualiza informações sobre a conexão. Se a conexão tiver sido marcada como persistente no registro, o sistema continuará restaurando a conexão no próximo logon. Se a conexão não foi marcada como persistente, a função ignora a configuração do sinalizador CONNECT_UPDATE_PROFILE.
CONNECT_UPDATE_PROFILE	O sistema atualiza o perfil do usuário com as informações de que a conexão não é mais persistente. O sistema não restaurará essa conexão durante as operações de logon subsequentes. (Desconectar recursos usando nomes remotos não tem efeito em conexões persistentes.)

[in] fForce

Especifica se a desconexão deve ocorrer se houver arquivos ou trabalhos abertos na conexão. Se esse parâmetro for FALSE, a função falhará se houver arquivos ou trabalhos abertos.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um código de erro do sistema, como um dos valores a seguir.

Código de retorno	Descrição
ERROR_BAD_PROFILE	O perfil do usuário está em um formato incorreto.
ERROR_CANNOT_OPEN_PROFILE	O sistema não consegue abrir o perfil do usuário para processar conexões persistentes.
ERROR_DEVICE_IN_USE	O dispositivo está sendo usado por um processo ativo e não pode ser desconectado.
ERROR_EXTENDED_ERROR	Ocorreu um erro específico da rede. Para obter uma descrição do erro, chame a função WNetGetLastError .
ERROR_NOT_CONNECTED	O nome especificado pelo parâmetro lpName não é um dispositivo redirecionado ou o sistema não está conectado ao dispositivo especificado pelo parâmetro .
ERROR_OPEN_FILES	Há arquivos abertos e o parâmetro fForce é FALSE.

Comentários

Windows Server 2003 e Windows XP: As funções WNet criam e excluem letras de unidade de rede no namespace do dispositivo MS-DOS associado a uma sessão de logon porque os dispositivos MS-DOS são identificados por AuthenticationID. (Uma AuthenticationID é o identificador local exclusivo, ou LUID, associado a uma sessão de logon.) Isso pode afetar aplicativos que chamam uma das funções WNet para criar uma letra de unidade de rede em um logon de usuário, mas consultam letras de unidade de rede existentes em um logon de usuário diferente. Um exemplo dessa situação pode ser quando o segundo logon de um usuário é criado em uma sessão de logon, por exemplo, chamando a função CreateProcessAsUser e o segundo logon executa um aplicativo que chama a função GetLogicalDrives . GetLogicalDrives não retorna letras de unidade de rede criadas por uma função WNet no primeiro logon. Observe que, no exemplo anterior, a primeira sessão de logon ainda existe e o exemplo pode se aplicar a qualquer sessão de logon, incluindo uma sessão dos Serviços de Terminal. Para obter mais informações, consulte Definindo um nome de dispositivo MS-DOS.

Exemplos

Para obter um exemplo de código que ilustra como cancelar uma conexão com um recurso de rede com uma chamada para a função WNetCancelConnection2 , consulte Cancelando uma conexão de rede.

Observação

O cabeçalho winnetwk.h define WNetCancelConnection2 como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winnetwk.h
Biblioteca	Mpr.lib
DLL	Mpr.dll