Método Session.FormatRecord

El método FormatRecord del objeto Session devuelve una cadena con formato a partir de una plantilla y los datos de registro.

Sintaxis

Session.FormatRecord(
  record
)

Parámetros

record

Objeto Record necesario que contiene una plantilla y los datos a los que se va a dar formato. La cadena de la plantilla debe establecerse en el campo 0, seguido de los parámetros de datos a los que se hace referencia.

Valor devuelto

Este método no devuelve ningún valor.

Comentarios

El método FormatRecord usa el siguiente proceso de formato.

Los parámetros a los que se va a dar formato se escriben entre corchetes [.]. Los corchetes se pueden iterar porque las sustituciones se resuelven desde dentro hacia fuera.

Si una parte de la cadena se encuentra entre llaves { } y no contiene corchetes, se deja sin cambios, incluidas las llaves.

Si una parte de la cadena se encuentra entre llaves y contiene uno o varios nombres de propiedad y si se encuentran todas las propiedades, el texto (con las sustituciones resueltas) se muestra sin las llaves. Si no se encuentra alguna de las propiedades, se quitan tanto el texto entre llaves como las propias llaves.

Para dar formato a cadenas mediante el método FormatRecord

  1. Para sustituir los parámetros numéricos se debe reemplazar el marcador por el valor del campo de registro correspondiente, y ni los valores nulos ni los ausentes que generan texto.
  2. La cadena resultante se procesa reemplazando los parámetros que no son de registro por los valores correspondientes, como se indica en las descripciones siguientes.
    • Si se encuentra una subcadena con el formato "[propertyname]", se reemplaza por el valor de la propiedad .
    • Si se encuentra una subcadena con el formato "[%environmentvariable]", se sustituye el valor de la variable de entorno.
    • Si se encuentra una subcadena con el formato [#filekey], se reemplaza por la ruta de acceso completa del archivo, y el valor filekey se usa como clave en la tabla File. El valor de [#filekey] permanece en blanco y no se reemplaza por una ruta de acceso hasta que el instalador ejecuta la acción CostInitialize, la acción FileCost y la acción CostFinalize. El valor de [#filekey] depende del estado de instalación del componente al que pertenece el archivo. Si el componente se ejecuta desde el origen, el valor es la ruta de acceso a la ubicación de origen del archivo. Si el componente se ejecuta localmente, el valor es la ruta de acceso a la ubicación de destino del archivo después de la instalación. Si el componente está ausente, la ruta de acceso está en blanco. Para más información sobre cómo comprobar el estado de instalación de los componentes, consulte Comprobación de la instalación de características, componentes y archivos.
    • Si se encuentra una subcadena con el formato [$componentkey], se reemplaza por el directorio de instalación del componente, y el valor componentkey se usa como clave en la tabla Componente. El valor de [$componentkey] permanece en blanco y no se reemplaza por ningún directorio hasta que el instalador ejecuta la acción CostInitialize, la acción FileCost y la acción CostFinalize. El valor de [$componentkey] depende del estado de instalación del componente. Si el componente se ejecuta desde el origen, el valor es el directorio de origen del archivo. Si el componente se ejecuta localmente, el valor es el directorio de destino después de la instalación. Si el componente está ausente, el valor se deja en blanco. Para más información sobre cómo comprobar el estado de instalación de los componentes, consulte Comprobación de la instalación de características, componentes y archivos.
    • Si se encuentra una subcadena con el formato "[\c]", se reemplaza por el carácter sin ningún procesamiento adicional. Sólo se mantiene el primer carácter después de la barra diagonal inversa; lo demás se quita.

Requisitos

Requisito Value
Versión
Windows Installer 5.0 en Windows Server 2012, Windows 8, Windows Server 2008 R2 o Windows 7. Windows Installer 4.0 o Windows Installer 4.5 en Windows Server 2008 o Windows Vista. Windows Installer en Windows Server 2003 o Windows XP
Archivo DLL
Msi.dll
IID
IID_ISession se define como 000C109E-0000-0000-C000-000000000046

Consulte también

Con formato

Tipos de datos de columna