Método Session.FormatRecord

O método FormatRecord do objeto Session retorna uma cadeia de caracteres formatada de um modelo e dados de registro.

Sintaxe

Session.FormatRecord(
  record
)

Parâmetros

record

Objeto Record obrigatório que contém um modelo e os dados a serem formatados. A cadeia de caracteres de modelo deve ser definida no campo 0 seguido pelos parâmetros de dados referenciados.

Valor retornado

Esse método não retorna um valor.

Comentários

O método FormatRecord usa o processo de formato a seguir.

Os parâmetros a serem formatados são colocados entre colchetes [..]. Os colchetes podem ser iterados porque as substituições são resolvidas de dentro para fora.

Se uma parte da cadeia de caracteres estiver entre chaves { } e não contiver colchetes, a parte será deixada inalterada, incluindo as chaves.

Se uma parte da cadeia de caracteres estiver entre chaves e contiver um ou mais nomes de propriedade e todas as propriedades forem encontradas, o texto (com as substituições resolvidas) será exibido sem as chaves. Se alguma das propriedades não for encontrada, todo o texto nas chaves e as chaves serão removidos.

Para formatar cadeias de caracteres usando o método FormatRecord

1. Os parâmetros numéricos são trocados substituindo o marcador pelo valor do campo de registro correspondente, e os valores ausentes ou nulos não produzem texto.
2. A cadeia de caracteres resultante é processada substituindo os parâmetros não registrados pelos valores correspondentes, conforme observado nas descrições a seguir.
   • Se uma substring do formato [propertyname] for encontrada, ela será substituída pelo valor da propriedade.
   • Se uma substring do formato [%environmentvariable] for encontrada, o valor da variável de ambiente será substituído.
   • Se uma substring do formato [#filekey] for encontrada, ela será substituída pelo caminho completo do arquivo, pelo valor de filekey usado como uma chave na tabela File. O valor de [#filekey] permanece em branco e só é substituído por um caminho quando o instalador executa a ação CostInitialize, a ação FileCost e a ação CostFinalize. O valor de [#filekey] depende do estado de instalação do componente ao qual o arquivo pertence. Se o componente for executado por meio da origem, o valor será o caminho para o local de origem do arquivo. Se o componente for executado localmente, o valor será o caminho para o local de destino do arquivo após a instalação. Se o componente estiver ausente, o caminho estará em branco. Para obter mais informações sobre como verificar o estado de instalação dos componentes, confira Como verificar a instalação de recursos, componentes e arquivos.
   • Se uma substring do formato [$componentkey] for encontrada, ela será substituída pelo diretório de instalação do componente, pelo valor de componentkey usado como uma chave na tabela Component. O valor de [$componentkey] permanece em branco e só é substituído por um diretório quando o instalador executa a ação CostInitialize, a ação FileCost e a ação CostFinalize. O valor de [$componentkey] depende do estado de instalação do componente. Se o componente for executado por meio da origem, o valor será o diretório de origem do arquivo. Se o componente for executado localmente, o valor será o diretório de destino após a instalação. Se o componente estiver ausente, o valor será deixado em branco. Para obter mais informações sobre como verificar o estado de instalação dos componentes, confira Como verificar a instalação de recursos, componentes e arquivos.
   • Se uma substring do formato "[\c]" for encontrada, ela será substituída pelo caractere, sem nenhum processamento adicional. Somente o primeiro caractere depois da barra invertida é mantido. O restante é removido.

Requisitos

Requisito	Valor
Versão	Windows Installer 5.0 no Windows Server 2012, no Windows 8, no Windows Server 2008 R2 ou no Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 no Windows Server 2008 ou no Windows Vista. Windows Installer no Windows Server 2003 ou no Windows XP
DLL	Msi.dll
IID	IID_ISession é definido como 000C109E-0000-0000-C000-000000000046

Confira também

Formatted

Tipos de dados de coluna