Compartilhar via


Função DavGetTheLockOwnerOfTheFile (davclnt.h)

Retorna o proprietário do bloqueio de arquivo para um arquivo bloqueado em um servidor WebDAV.

Sintaxe

DWORD DavGetTheLockOwnerOfTheFile(
  [in]            LPCWSTR FileName,
  [out, optional] PWSTR   LockOwnerName,
  [in, out]       PULONG  LockOwnerNameLengthInBytes
);

Parâmetros

[in] FileName

Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém o nome de um arquivo bloqueado no servidor WebDAV. Essa cadeia de caracteres deve estar em um dos seguintes formatos:

  • \\server\path\filename
  • drive:\filename
em que server é o nome de um servidor, path é o caminho para um arquivo remoto no servidor, filename é um nome de arquivo válido e drive é a letra da unidade para a qual um compartilhamento remoto é mapeado no computador local. (Um compartilhamento é um diretório em um servidor que é disponibilizado aos usuários pela rede.)

[out, optional] LockOwnerName

Um ponteiro para um buffer alocado pelo chamador que recebe o nome do proprietário do bloqueio de arquivo. Esse parâmetro é opcional e pode ser NULL. Se for NULL, o parâmetro LockOwnerNameLengthInBytes deverá apontar para zero na entrada.

[in, out] LockOwnerNameLengthInBytes

Um ponteiro para uma variável que na entrada especifica o tamanho máximo, em caracteres Unicode, do buffer para o qual o parâmetro LockOwnerName aponta. Se a função for bem-sucedida, na saída, a variável receberá o número de caracteres que foram copiados para o buffer. Se a função falhar com ERROR_INSUFFICIENT_BUFFER, na saída a variável receberá o número de caracteres necessários para armazenar o nome do proprietário do bloqueio, incluindo o caractere NULL de terminação.

Valor retornado

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

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_INSUFFICIENT_BUFFER
O buffer para o qual o parâmetro LockOwnerName aponta não era grande o suficiente para armazenar o nome do proprietário do bloqueio.
ERROR_INVALID_PARAMETER
Um ou mais valores de parâmetro não eram válidos. Por exemplo, esse código de erro será retornado se o parâmetro FileName for um ponteiro nulo .

Comentários

Se uma chamada para uma função como CreateFile para um arquivo em um servidor WebDAV falhar com ERROR_LOCK_VIOLATION, você poderá usar a função DavGetTheLockOwnerOfTheFile para determinar o proprietário do bloqueio de arquivo.

Para obter o comprimento do buffer necessário para o buffer LockOwnerName , chame DavGetTheLockOwnerOfTheFile com LockOwnerName definido como NULL e LockOwnerNameLengthInBytes definido como zero. O valor retornado é ERROR_INSUFFICIENT_BUFFER e, na saída, o parâmetro LockOwnerNameLengthInBytes recebe o comprimento do buffer necessário.

Requisitos

   
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho davclnt.h
Biblioteca Davclnt.lib
DLL Davclnt.dll