Session.FormatRecord メソッド

Session オブジェクトの FormatRecord メソッドは、テンプレートから書式設定された文字列を返し、データを記録します。

構文

Session.FormatRecord(
  record
)

パラメーター

record

書式設定するテンプレートとデータを含む必須 の Record オブジェクト。 テンプレート文字列は、フィールド 0 の後に参照されるデータ パラメーターを設定する必要があります。

戻り値

このメソッドは値を返しません。

解説

FormatRecord メソッドは、次の形式プロセスを使用します。

書式設定するパラメーターは、角かっこ [..] で囲まれます。 置換は内側から解決されるため、角かっこを反復処理できます。

文字列の一部が中かっこ { } で囲まれており、角かっこが含まれていない場合、部分は中かっこを含めて変更されません。

文字列の一部が中かっこで囲まれており、1 つ以上のプロパティ名が含まれている場合、すべてのプロパティが見つかった場合、テキスト (解決された置換) は中かっこなしで表示されます。 いずれかのプロパティが見つからない場合は、中かっこと中かっこ自体のすべてのテキストが削除されます。

FormatRecord メソッドを使用して文字列を書式設定するには

  1. 数値パラメーターは、マーカーを対応するレコード フィールドの値に置き換え、テキストを生成しない欠損値または Null 値で置き換えることで置き換えます。
  2. 結果の文字列は、次の説明に示すように、レコード以外のパラメーターを対応する値に置き換えることで処理されます。
    • "[propertyname]" という形式の部分文字列が見つかった場合は、プロパティの値に置き換えられます。
    • "[%environmentvariable] という形式の部分文字列が見つかった場合は、環境変数の値が置き換えられます。
    • フォーム [#filekey] の部分文字列が見つかった場合は、ファイルの完全なパスに置き換えられ、ファイル テーブルのキーとして使用される値 filekey置き換えられます。 [#filekey] の値は空白のままであり、インストーラーが CostInitialize アクションFileCost アクション、および CostFinalize アクションを実行するまでパスに置き換えされません。 [#filekey] の値は、ファイルが属するコンポーネントのインストール状態によって異なります。 コンポーネントがソースから実行されている場合、値はファイルのソースの場所へのパスです。 コンポーネントがローカルで実行されている場合、値はインストール後のファイルのターゲットの場所へのパスです。 コンポーネントがない場合、パスは空白です。 コンポーネントのインストール状態の確認の詳細については、「 機能、コンポーネント、ファイルのインストールの確認」を参照してください。
    • フォーム [$componentkey] の部分文字列が見つかった場合は、コンポーネントのインストール ディレクトリに置き換えられ、値 componentkeyComponent テーブルのキーとして使用されます。 [$componentkey] の値は空白のままであり、インストーラーが CostInitialize アクションFileCost アクション、および CostFinalize アクションを実行するまで、ディレクトリに置き換えされません。 [$componentkey] の値は、コンポーネントのインストール状態によって異なります。 コンポーネントがソースから実行されている場合、値はファイルのソース ディレクトリです。 コンポーネントがローカルで実行されている場合、値はインストール後のターゲット ディレクトリです。 コンポーネントがない場合、値は空白のままです。 コンポーネントのインストール状態の確認の詳細については、「 機能、コンポーネント、ファイルのインストールの確認」を参照してください。
    • "[\c]" という形式の部分文字列が見つかった場合、それ以降の処理は行わずに文字に置き換えられます。 円記号の後の最初の文字のみが保持されます。それ以外はすべて削除されます。

要件

要件
バージョン
Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 でインストーラー 5.0 をWindowsします。 Windows Server 2008 または Windows Vista のインストーラー 4.0 または Windows インストーラー 4.5 をWindowsします。 Windows Server 2003 または Windows XP でインストーラーをWindowsする
[DLL]
Msi.dll
IID
IID_ISessionは、000C109E-0000-0000-C000-0000000000046 と定義されます。

関連項目

フォーマット

列データ型