MsiRecordSetStreamA function

The MsiRecordSetStream function sets a record stream field from a file. Stream data cannot be inserted into temporary fields.

Syntax

UINT MsiRecordSetStreamA(
  MSIHANDLE hRecord,
  UINT      iField,
  LPCSTR    szFilePath
);

Parameters

hRecord

Handle to the record.

iField

Specifies the field of the record to set.

szFilePath

Specifies the path to the file containing the stream.

Return Value

The MsiRecordSetStream function returns the following values:

Remarks

The contents of the file specified in the MsiRecordSetStream function is 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 a Null pointer for szFilePath. Do not pass a pointer to an empty string, "", to reset the stream.

See also OLE Limitations on Streams.

If the function fails, you can obtain extended error information by using MsiGetLastErrorRecord.

Requirements

   
Windows version Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer on Windows Server 2003 or Windows XP
Target Platform Windows
Header msiquery.h
Library Msi.lib
DLL Msi.dll

See Also

Record Processing Functions