FormatRecord Method (record, format)

DTF API

Copy image CopyHover image
Deployment Tools Foundation FormatRecord Method (record, format)
Deployment Tools Foundation NamespacesMicrosoft.Deployment.WindowsInstallerSessionFormatRecord(Record, String)
Returns a formatted string from record data using a specified format.
Declaration Syntax
C# Visual Basic Visual C++ F#
[ObsoleteAttribute("This method is obsolete because it has undesirable side-effects. As an alternative, set the Record's FormatString property separately before calling the FormatRecord() override that takes only the Record parameter.")]
public string FormatRecord(
	Record record,
	string format
)
<ObsoleteAttribute("This method is obsolete because it has undesirable side-effects. As an alternative, set the Record's FormatString property separately before calling the FormatRecord() override that takes only the Record parameter.")>
Public Function FormatRecord ( 
	record As Record,
	format As String
) As String
public:
[ObsoleteAttribute(L"This method is obsolete because it has undesirable side-effects. As an alternative, set the Record's FormatString property separately before calling the FormatRecord() override that takes only the Record parameter.")]
String^ FormatRecord(
	Record^ record, 
	String^ format
)
[<ObsoleteAttribute("This method is obsolete because it has undesirable side-effects. As an alternative, set the Record's FormatString property separately before calling the FormatRecord() override that takes only the Record parameter.")>]
member FormatRecord : 
        record : Record * 
        format : string -> string 
Parameters
record (Record)
Record object containing a template and data to be formatted
format (String)
Format string to be used instead of field 0 of the Record
Return Value
String
A formatted string containing the record data
Remarks

Win32 MSI API: MsiFormatRecord

Exceptions
Exception Condition
InvalidHandleException the Record handle is invalid

Assembly: Microsoft.Deployment.WindowsInstaller (Module: Microsoft.Deployment.WindowsInstaller.dll) Version: 3.0.0.0 (3.11.1.2318)