Função SetupGetTargetPathA (setupapi.h)

Artigo
08/26/2023

[Essa função está disponível para uso nos sistemas operacionais indicados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. SetupAPI não deve mais ser usado para instalar aplicativos. Em vez disso, use o Windows Installer para desenvolver instaladores de aplicativos. SetupAPI continua a ser usado para instalar drivers de dispositivo.]

A função SetupGetTargetPath determina o diretório de destino para uma seção de lista de arquivos. A seção de lista de arquivos pode ser uma seção Copiar Arquivos , uma seção Excluir Arquivos ou uma seção Renomear Arquivos . Todos os arquivos na seção devem estar em um único diretório listado em uma seção DestinationDirs do arquivo INF.

Sintaxe

WINSETUPAPI BOOL SetupGetTargetPathA(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCSTR       Section,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Parâmetros

[in] InfHandle

Manipule para o arquivo INF de carga que contém uma seção DestinationDirs .

[in] InfContext

Ponteiro opcional para um contexto INF que especifica uma linha em uma seção de lista de arquivos cujo diretório de destino deve ser recuperado. Se InfContext for NULL, o parâmetro Section será usado.

[in] Section

Parâmetro opcional que especifica o nome de uma seção do arquivo INF cujo identificador é InfHandle. SetupGetTargetPath recupera o diretório de destino para esta seção. O parâmetro Section será ignorado se InfContext for especificado. Se nem InfContext nem Section forem especificados, a função recuperará o caminho de destino padrão do arquivo INF. Você deve usar uma cadeia de caracteres terminada em nulo.

[in, out] ReturnBuffer

Ponteiro opcional para buffer para receber o caminho de destino totalmente qualificado. O caminho é garantido para não terminar com . Você deve usar uma cadeia de caracteres terminada em nulo. Você pode chamar a função uma vez para obter o tamanho do buffer necessário, alocar a memória necessária e, em seguida, chamar a função uma segunda vez para recuperar os dados. Usando essa técnica, você pode evitar erros devido a um tamanho de buffer insuficiente. Consulte a seção Comentários. Este parâmetro pode ser NULL.

[in] ReturnBufferSize

Tamanho do buffer apontado por ReturnBuffer, em caracteres. Isso inclui o terminador nulo .

[in, out] RequiredSize

Ponteiro opcional para uma variável que recebe o tamanho necessário para o buffer apontado por ReturnBuffer, em caracteres. Isso inclui o terminador nulo . Se o tamanho real necessário for maior do que o valor especificado por ReturnBufferSize, a função falhará e uma chamada para GetLastError retornará ERROR_INSUFFICIENT_BUFFER.

Retornar valor

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

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

Comentários

Se essa função for chamada com um ReturnBuffer de NULL e um ReturnBufferSize de zero, a função colocará o tamanho do buffer necessário para manter os dados especificados na variável apontada por RequiredSize. Se a função tiver êxito nisso, o valor retornado será um valor diferente de zero. Caso contrário, o valor retornado será zero e as informações de erro estendidas poderão ser obtidas chamando GetLastError.

Observação

O cabeçalho setupapi.h define SetupGetTargetPath 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	setupapi.h
Biblioteca	Setupapi.lib
DLL	Setupapi.dll