Edit

Share via

Record.ReadStream method

  • Article

The ReadStream method of the Record object reads a specified number of bytes from a record field that contains stream data.

Syntax

Record.ReadStream(
  field,
  length,
  format
)

Parameters

field

The required field number of the value within the record, 1-based.

length

The required number of bytes to read from the stream.

format

Required interpretation and return of the data bytes.

Parameter name Meaning
msiReadStreamInteger
0
 As a long integer the length must be 1 to 4.
msiReadStreamBytes
1
 The data as a BSTR—one byte per character.
msiReadStreamAnsi
2
 The ANSI bytes translated to a Unicode BSTR.
msiReadStreamDirect
3
 The byte pairs that are returned directly as a BSTR.

 

Return value

This method returns a string that contains the requested number of bytes read from a record field.

Remarks

The returned value of a nonexistent field is an Empty value. If the stream has fewer bytes that the count requested, the returned string is shortened appropriately.

For an example of this method, see Copy ANSI File Into a Database Field.

Requirements

Requirement Value
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
DLL
Msi.dll
IID
 IID_IRecord is defined as 000C1093-0000-0000-C000-000000000046