Função CreateHardLinkA (winbase.h)

Artigo
03/03/2024

Estabelece um link físico entre um arquivo existente e um novo arquivo. Essa função só tem suporte no sistema de arquivos NTFS e apenas para arquivos, não para diretórios.

Para executar essa operação como uma operação transacionada, use a função CreateHardLinkTransacted .

Sintaxe

BOOL CreateHardLinkA(
  [in] LPCSTR                lpFileName,
  [in] LPCSTR                lpExistingFileName,
       LPSECURITY_ATTRIBUTES lpSecurityAttributes
);

Parâmetros

[in] lpFileName

O nome do novo arquivo.

Esse parâmetro pode incluir o caminho, mas não pode especificar o nome de um diretório.

Por padrão, o nome é limitado a caracteres MAX_PATH. Para estender esse limite para 32.767 caracteres largos, preencha "\\?\" para o caminho. Para obter mais informações, confira Nomear arquivos, caminhos e namespaces.

Dica

A partir do Windows 10, versão 1607, você pode optar por remover a limitação de MAX_PATH sem acrescentar "\\?\". Consulte a seção "Limitação máxima de comprimento do caminho" de Arquivos de Nomenclatura, Caminhos e Namespaces para obter detalhes.

[in] lpExistingFileName

O nome do arquivo existente.

Esse parâmetro pode incluir o caminho que não pode especificar o nome de um diretório.

Dica

lpSecurityAttributes

Reservados; deve ser NULL.

Valor retornado

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

Se a função falhar, o valor retornado será 0 (zero). Para obter informações de erro estendidas, chame GetLastError.

O número máximo de links rígidos que podem ser criados com essa função é 1023 por arquivo. Se mais de 1023 links forem criados para um arquivo, um erro resultará.

Se você passar um nome maior que MAX_PATH caracteres para o parâmetro lpFileName ou lpExistingFileName da versão ANSI dessa função ou para a versão Unicode dessa função sem acrescentar "\\?\" ao caminho, a função retornará ERROR_PATH_NOT_FOUND.

Comentários

Qualquer entrada de diretório para um arquivo criado com CreateFile ou CreateHardLink é um link rígido para um arquivo associado. Um link rígido adicional criado com a função CreateHardLink permite que você tenha várias entradas de diretório para um arquivo, ou seja, vários links rígidos para o mesmo arquivo, que podem ser nomes diferentes no mesmo diretório ou os mesmos nomes ou nomes diferentes em diretórios diferentes. No entanto, todos os links rígidos para um arquivo devem estar no mesmo volume.

Como os links rígidos são apenas entradas de diretório para um arquivo, muitas alterações nesse arquivo são instantaneamente visíveis para aplicativos que o acessam por meio dos links rígidos que fazem referência a ele. No entanto, as informações de atributo e tamanho da entrada do diretório são atualizadas apenas para o link por meio do qual a alteração foi feita.

O descritor de segurança pertence ao arquivo ao qual um link rígido aponta. O link em si é apenas uma entrada de diretório e não tem um descritor de segurança. Portanto, quando você altera o descritor de segurança de um link rígido, você altera o descritor de segurança do arquivo subjacente e todos os links rígidos que apontam para o arquivo permitem o acesso recém-especificado. Você não pode fornecer a um arquivo diferentes descritores de segurança por link rígido.

Essa função não modifica o descritor de segurança do arquivo ao qual estar vinculado, mesmo que as informações do descritor de segurança sejam passadas no parâmetro lpSecurityAttributes .

Use DeleteFile para excluir links rígidos. Você pode excluí-los em qualquer ordem, independentemente da ordem em que elas são criadas.

Sinalizadores, atributos, acesso e compartilhamento especificados em CreateFile operam por arquivo. Ou seja, se você abrir um arquivo que não permite o compartilhamento, outro aplicativo não poderá compartilhar o arquivo criando um novo link rígido para o arquivo.

Quando você cria um link rígido no sistema de arquivos NTFS, as informações de atributo de arquivo na entrada do diretório são atualizadas somente quando o arquivo é aberto ou quando GetFileInformationByHandle é chamado com o identificador de um arquivo específico.

Comportamento simbólico do link – se o caminho apontar para um link simbólico, a função criará um link rígido para o link simbólico.

No Windows 8 e Windows Server 2012, essa função é compatível com as tecnologias a seguir.

Tecnologia	Com suporte
Protocolo SMB (SMB) 3.0	Sim
TFO (Failover transparente) do SMB 3.0	No
SMB 3.0 com compartilhamentos de arquivos de expansão (SO)	No
Sistema de arquivos de Volume Compartilhado Clusterizado (CsvFS)	Sim
ReFS (Sistema de Arquivos Resiliente)	No

Observe que o SMB 3.0 não dá suporte à criação de links rígidos em compartilhamentos com funcionalidade de disponibilidade contínua.

Exemplos

O snippet de código a seguir mostra como chamar CreateHardLink para que ele não modifique o descritor de segurança de um arquivo. O parâmetro pszExistingFileName pode ser o nome do arquivo original ou qualquer link existente para um arquivo. Depois que esse código é executado, pszNewLinkName refere-se ao arquivo.

  BOOL fCreatedLink = CreateHardLink( pszNewLinkName, 
                                      pszExistingFileName, 
                                      NULL ); // reserved, must be NULL

  if ( fCreatedLink == FALSE )
   {
    ;// handle error condition
   }

Observação

O cabeçalho winbase.h define CreateHardLink 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 XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winbase.h (inclua Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll