Compartilhar via


Função GetLogContainerName (clfsw32.h)

Recupera o nome do caminho completo do contêiner especificado. Essa função é usada principalmente para obter o nome de caminho completo de um contêiner referenciado na estrutura CLFS_CONTAINER_INFORMATION que é retornado em chamadas para ScanLogContainers.

Sintaxe

CLFSUSER_API BOOL GetLogContainerName(
  [in]                HANDLE            hLog,
  [in]                CLFS_CONTAINER_ID cidLogicalContainer,
  [in, out]           LPCWSTR           pwstrContainerName,
  [in]                ULONG             cLenContainerName,
  [in, out, optional] PULONG            pcActualLenContainerName
);

Parâmetros

[in] hLog

Um identificador para o log obtido de uma chamada bem-sucedida para CreateLogFile.

O identificador de log pode se referir a um fluxo de log ou a um log físico.

[in] cidLogicalContainer

O identificador exclusivo associado a um contêiner.

[in, out] pwstrContainerName

Um ponteiro para um buffer alocado pelo usuário para receber o caminho completo e o nome do contêiner de log, em caracteres largos.

[in] cLenContainerName

O tamanho do buffer apontado por pwstrContainerName, em caracteres.

[in, out, optional] pcActualLenContainerName

Um ponteiro para uma variável para receber a contagem real de caracteres do nome do caminho de contêiner completo recuperado.

Se a função for bem-sucedida, o valor desse parâmetro será menor ou igual a cLenContainerName. Se o buffer não for grande o suficiente para armazenar todo o nome do caminho do contêiner, a função falhará com ERROR_MORE_DATA e definirá esse parâmetro para o tamanho necessário para o nome do caminho completo. Para outras falhas, o valor não é definido.

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. A lista a seguir identifica os possíveis códigos de erro:

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho clfsw32.h
Biblioteca Clfsw32.lib
DLL Clfsw32.dll

Confira também

CLFS_CONTAINER_INFORMATION

Funções comuns do sistema de arquivos de log

ScanLogContainers