Função WNetCancelConnectionA (winnetwk.h)

Artigo
11/20/2024

A função WNetCancelConnection cancela uma conexão de rede existente.

A função WNetCancelConnection é fornecida para compatibilidade com versões de 16 bits do Windows. Outros aplicativos baseados no Windows devem chamar a função WNetCancelConnection2.

Sintaxe

DWORD WNetCancelConnectionA(
  [in] LPCSTR lpName,
  [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.

Quando esse parâmetro especifica um dispositivo local redirecionado, a função cancela apenas o redirecionamento de dispositivo especificado. Se o parâmetro especificar um recurso de rede remota, somente as conexões com redes remotas sem dispositivos serão canceladas.

[in] fForce

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

Valor de retorno

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á em uso 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 no momento.
ERROR_OPEN_FILES	Há arquivos abertos e o parâmetro fForce é false.

Observações

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 MS-DOS dispositivos são identificados pela AuthenticationID. (Uma AuthenticationID é o identificador localmente 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 ser aplicado a qualquer sessão de logon, incluindo uma sessão dos Serviços de Terminal. Para obter mais informações, consulte Definindo umde nome do dispositivo MS-DOS.

Nota

O cabeçalho winnetwk.h define WNetCancelConnection 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. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winnetwk.h
biblioteca	Mpr.lib
de DLL	Mpr.dll

Consulte também

WNetAddConnection

WNetAddConnection2

WNetCancelConnection2

WNetGetConnection

Visão geral WNet (Rede windows)

funções de rede do Windows

Compartilhar via