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

Registro

Objeto Record obrigatório que contém um modelo e dados a serem formatados. A cadeia de caracteres de modelo deve ser definida no campo 0, seguida por quaisquer 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 ficará inalterada, incluindo as chaves.

Se uma parte da cadeia de caracteres estiver entre chaves e contiver um ou mais nomes de propriedade, e se 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 substituídos pela substituição do marcador pelo valor do campo de registro correspondente, por valores ausentes ou nulos que não produzem texto.
  2. A cadeia de caracteres que resulta é processada substituindo os parâmetros não registrados pelos valores correspondentes, conforme observado nas descrições a seguir.
    • Se uma subcadeia de caracteres do formulário "[propertyname]" for encontrada, ela será substituída pelo valor da propriedade.
    • Se uma subcadeia de caracteres do formulário "[%environmentvariable]" for encontrada, o valor da variável de ambiente será substituído.
    • Se uma subcadeia de caracteres do formulário [#filekey] for encontrada, ela será substituída pelo caminho completo do arquivo, com a chave de arquivo de valor usada como uma chave na tabela Arquivo. O valor de [#filekey] permanece em branco e não é substituído por um caminho até que o instalador execute 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 estiver sendo executado da origem, o valor será o caminho para o local de origem do arquivo. Se o componente estiver sendo 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, consulte Verificando a instalação de recursos, componentes, arquivos.
    • Se uma subcadeia de caracteres do formulário [$componentkey] for encontrada, ela será substituída pelo diretório de instalação do componente, pela chave de componente de valor usada como chave na tabela Componente. O valor de [$componentkey] permanece em branco e não é substituído por um diretório até que o instalador execute 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 estiver sendo executado a partir da origem, o valor será o diretório de origem do arquivo. Se o componente estiver sendo 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, consulte Verificando a instalação de recursos, componentes, arquivos.
    • Se uma subcadeia de caracteres do formulário "[\c]" for encontrada, ela será substituída pelo caractere sem nenhum processamento adicional. Somente o primeiro caractere depois que a barra invertida é mantida; todo o resto é removido.

Requisitos

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

Confira também

Formatado

Tipos de dados de coluna