SetStream Method (fieldName, filePath)

DTF API

previous page next page
Copy image CopyHover image
Deployment Tools Foundation SetStream Method (fieldName, filePath)
Deployment Tools Foundation Namespaces ► Microsoft.Deployment.WindowsInstaller ► Record ► SetStream(String, String)
Sets a record stream field from a file. Stream data cannot be inserted into temporary fields.
Declaration Syntax
C# Visual Basic Visual C++ F# 
public void SetStream(
	string fieldName,
	string filePath
)
Public Sub SetStream ( 
	fieldName As String,
	filePath As String
)
public:
void SetStream(
	String^ fieldName, 
	String^ filePath
)
member SetStream : 
        fieldName : string * 
        filePath : string -> unit
Parameters
fieldName (String)
Specifies the field name of the Record to set.
filePath (String)
Specifies the path to the file containing the stream.
Remarks

The contents of the specified file are read into a stream object. The stream persists if the Record is inserted into the Database and the Database is committed. To reset the stream to its beginning you must pass in null for filePath. Do not pass an empty string, "", to reset the stream.

Setting a stream with this method is more efficient than setting a field to a FileStream object.

Exceptions
Exception Condition
ArgumentOutOfRangeException The field name does not match any of the named fields in the Record.

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

previous page start next page