Função SetupQueueRenameA (setupapi.h)

[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 SetupQueueRename coloca uma operação de renomeação de arquivo individual em uma fila de arquivos de instalação.

Sintaxe

WINSETUPAPI BOOL SetupQueueRenameA(
  [in] HSPFILEQ QueueHandle,
  [in] PCSTR    SourcePath,
  [in] PCSTR    SourceFilename,
  [in] PCSTR    TargetPath,
  [in] PCSTR    TargetFilename
);

Parâmetros

[in] QueueHandle

Manipule para uma fila de arquivos de instalação, conforme retornado por SetupOpenFileQueue.

[in] SourcePath

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho de origem do arquivo a ser renomeado. Se SourceFileName não for especificado, SourcePath será considerado o caminho completo.

[in] SourceFilename

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica a parte do nome do arquivo a ser renomeada. Se não for especificado, SourcePath será o caminho completo.

[in] TargetPath

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o diretório de destino. Quando esse parâmetro é especificado, a operação de renomeação é, na verdade, uma operação de movimentação. Se TargetPath não for especificado, o arquivo será renomeado, mas permanecerá em seu local atual.

[in] TargetFilename

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o novo nome para o arquivo de origem.

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

Como se supõe-se que as operações de renomeação ocorram em mídia fixa, o usuário não será solicitado quando a fila for confirmada.

Observação

O cabeçalho setupapi.h define SetupQueueRename 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

Confira também

Funções

Visão geral

SetupQueueCopy

SetupQueueDelete

SetupQueueRenameSection